Intel® SoC Watch for oneAPI Release Notes

ID 776965
Updated 4/4/2023
Version
Public

author-image

By

Introduction

This document provides the information on new releases for Intel® SoC Watch for oneAPI. Intel SoC Watch is available in Intel® oneAPI Base Toolkit as a part of Intel® VTune™ Profiler.

Version History

Date Version Major Change Summary
Mar. 2023 2022.5 Fixed an issue with os-cpu-cstate and os-cpu-pstate that caused empty result file.
Added note summary report table for acpi-dstate explaining how to interpret results in the event of questionable data
Bug fixes
Sep. 2022 2022.1 Added support for Intel platform code named Alder Lake and Intel discrete
graphics card code named DG2.
Bug fixes
Apr. 2022 2021.4 Added support for Intel platforms code named Rocket Lake and Tiger Lake-H.
Added support for Intel platforms code named Ice Lake-X and Cooper Lake-X.
Bug fixes
Dec. 2021 2021.3 General enhancements and third-party library updates. Added PMT-based metric support when using Linux* kernel v5.11.
Sep. 2021 2021.2 Enhanced WakeupAnalysis report with idle time per process.
Improved ia-throt-rsn support when Windows* OS secure modes are
enabled.
Jun. 2021 2021.1 Added System Name, Operating System name, kernel number, GUID to PMT description to the top of the summary and trace report. Update socwatch driver for Linux kernel 5.12 (SFI API was removed)
Mar. 2021 2020.5 Included in Intel VTune Profiler 2021.2. Changed hw-cpu-pstate to report frequencies per thread rather than per
core. Added term integrated to hw-igfx-cstate and hw-igfx-pstate report titles.
Nov. 2020 2020.4 Initial Release
     

Where to Find the Release

Please follow the steps to download the oneAPI Base Toolkit from the Web Configurator, and follow the installation instructions to install. SoC Watch is part of VTune Profiler in Intel® oneAPI Base Toolkit

New in This Release

Linux* Release Notes Windows* Release Notes

Intel SoC Watch for Windows*

The 2022.5 release has a fix for these issues:
• Fixed an issue with os-cpu-cstate and os-cpu-pstate that caused empty result file. Now, an entry Unknown will be displayed in the summary table regardless of whether hibernation or standby occurred whereas, earlier, it would only be displayed in those cases.
• Added note summary report table for acpi-dstate explaining how to interpret results in the event of questionable data

Intel SoC Watch for Linux* / Android*

The 2022.5 release contains few bug fixes but no major changes.

Linux* Release Notes Windows* Release Notes

Intel SoC Watch for Windows*

The 2022.1 release (socwatch driver v2.16.7) contains these changes:
• Added support for Intel platforms code named Alder Lake. Note: Does not include Intel platform code named Alder Lake -N.
• Added support for feature -f dgfx-pwr on Intel discrete graphics card code named DG2 EU128 and EU512.
• Reverted change from prior release, allowing use of option --update-usage-consent yes, to permit
collection of tool usage analytics. This is permissible now because the text explaining the "yes" consent
has been added to the help output and the User's Guide so that it will be read before use of the option.
• Changed the help output to provide better guidance on the usage of options --input and --output.
Changes are reflected in the User's Guide.
• Support for Intel platforms code named Apollo Lake and Gemini Lake will be removed in the next SoC
Watch release.

Intel SoC Watch for Linux* / Android*

The 2022.1 release (socwatch driver v2.15.2) contains these changes:
• Added support for Intel platforms code named Alder Lake. Note: Does not include Intel platform code
named Alder Lake -N.
• Added support for feature -f dgfx-pwr on Intel discrete graphics card code named DG2 EU128 and EU512.
• Reverted change from prior release, allowing use of option --update-usage-consent yes, to permit
collection of tool usage analytics. This is permissible now because the text explaining the "yes" consent
has been added to the help output and the User's Guide so that it will be read before use of the option.
• Changed the help output to provide better guidance on the usage of options --input and --output.
Changes are reflected in the User's Guide.
• Support for Intel platforms code named Apollo Lake and Gemini Lake will be removed in the next SoC
Watch release.

Linux* Release Notes Windows* Release Notes

Intel SoC Watch for Windows*

The 2021.4 release (socwatch driver v2.16.6) contains these changes:

• Added support for Intel platforms code named Tiger Lake-H and Rocket Lake.
• Added support for Intel server platforms code named Ice Lake-X and Cooper Lake-X.
• Added new option --revoke-usage-consent to remove consent to share Intel SoC Watch usage data via Google Analytics. Use this option as an alternative to the interactive option --update-usageconsent. Modified option --update-usage-consent to no longer accept ‘yes’ as a command line parameter.
• Improved message when hibernation occurs to make it clear that option -m must be added to the collection command line to get correct reporting for residency data.
• Improved WakeupAnalysis histograms report for feature -f os-cpu-cstate when –m is used. It now sorts Cores and Threads in numerical order.

Intel SoC Watch for Linux* / Android*

The 2021.4 release (socwatch driver v2.15.2) contains these changes:

• Added support for Intel platforms code named Tiger Lake-H and Rocket Lake.
• Added support for Intel server platforms code named Ice Lake-X and Cooper Lake-X.
• Added new option --revoke-usage-consent to remove consent to share Intel SoC Watch usage data via Google Analytics. Use this option as an alternative to the interactive option --update-sage consent. Modified option --update-usage-consent to no longer accept ‘yes’ as a command line parameter.

Linux* Release Notes Windows* Release Notes

Intel SoC Watch for Windows*

The 2021.3 release (driver v2.16.0) contains these changes:

This is a bug fix release. See Fixed Issues section for changes.

Intel SoC Watch for Linux* / Android*

The 2021.3 release (driver v2.15.0) contains these changes:

Update release 2021.3 has a fix for these issues.

  • Added support for collecting additional metrics when running on Linux kernel v5.11 or newer and the
    socwatch driver is not loaded (Intel SoC Watch must be executed with root privileges). On Intel platform
    code name Tiger Lake, these features include: display-bw, ipu-bw, io-bw, llc-bw, pcie-bw, typec-bw. On
    Intel® Iris® Xe discrete graphics card, the feature is: dgfx-pwr. These metrics use Intel® Platform Monitoring
    Technology (Intel® PMT) as the data source. Due to current limitations, if the socwatch driver is loaded, these
    features will be reported as unsupported. See Installation Notes section "Prerequisites for PMT and
    Discrete Graphics Metric Collection Using Intel SoC Watch" for more information.

Linux* Release Notes Windows* Release Notes

Intel SoC Watch for Windows*

The 2021.2 release (driver v2.15.7) contains these changes:

Enhanced WakeupAnalysis reported by feature –f os-cpu-cstate when –m is included:

  • Added table Histogram of Overall Idle Duration per Process to report histogram of the lengths of idle
    time between active time for each process. Three tables are produced that report Idle Hit Count, Idle
    Time in milliseconds, and Percentage of Total Collection time for each idle duration bucket.
  • Modified existing table Histogram of Overall Busy Duration per Process that reports histogram of the
    lengths of busy time per process to include partial busy times for processes that start prior to
    collection start or that end after collection ends. Also modified the percentage table to calculate
    percentage as ratio of total collection duration rather than total busy time for all processes. As a result,
    the table name changed from Histogram of Overall Busy Duration per Process: Percentage of Total
    Busy Time to Histogram of Overall Busy Duration per Process: Percentage of Total Collection Time.
    This makes the data comparable to the idle histogram report and it provides a consistent time basis for
    comparison of an individual process’s % number from run to run. The previous percentage calculation
    gave a comparison between processes in a single run.
  • Improved support for ia-throt-rsn on newer platforms when Windows* OS security modes (HyperV, VBS,
    HECi) are enabled on the platform. This is now disabled only if the platform CPUID is not included in the
    installed Windows OS approved list for the required register. When this occurs, Intel SoC Watch will print a
    message indicating the feature that could not be collected. For example, “NOTE: Cannot collect feature:
    ia-throt-rsn (restricted by OS security settings)”.

Intel SoC Watch for Linux* / Android*

The 2021.2 release (driver v2.14.3) contains these changes:

Update release 2021.2 has a fix for these issues.

  • Command line option --log (-l) has been fixed. It was broken in v2021.1.
  • Fixed issue resulting in a system hang when a user-mode application attempts to directly read the
    socwatch device driver.
  • In this release we have updated the driver build script to detect the version of the cpu_freq structure
    being used in the kernel and adjust accordingly for the socwatch driver to compile on Red Hat* Enterprise
    Linux 8 OS distribution. This eliminates the need to manually make the changes described in the
    installation notes.

Linux* Release Notes Windows* Release Notes

Intel SoC Watch for Windows*

The 2021.1 release (driver v2.15.5) contains these changes:

  • Added the following information to the top of the summary and trace reports:
    • System Name
    • Operating System name and build number
    • Added GUID to PMT description (as hexidecimal value)
  • Extended the message that is displayed when hibernation occurs to explain how the accuracy of hibernation time can be improved if needed, "Adding option -m can increase the accuracy of the time attributed to hibernation."
  • The Automation_Summary report (generated when using -r auto) now includes summary data for features ia-throt-rsn, gt-throt-rsn, and ring-throt-rsn, as well as other features which contain the table “Summary – Sampled: Counts”.
  • Modified order of feature reports within the summary file to bring relevant data closer together for faster reference.
  • The _WakeupAnalysis.csv report (generated when -m is used with feature os-cpu-cstate) has been modified as follows:
    • Separate tables for Idle and Busy histograms that report counts and time. Previously, these histogram tables had count and time values in a single table. Table titles were changed as part of this separation.
    • Added table “Histogram of Overall Busy Duration per Process: Percentage of Total Busy Time” to provide % calculation for the corresponding "Busy Time” table.

Intel SoC Watch for Linux* / Android*

The 2021.1 release (driver v2.14.2) contains these changes:

  • Added the following information to the top of the summary and trace reports:
    • System Name
    • Operating System name and kernel number
    • Added GUID to PMT description (as hexidecimal value)
  • Extended the message that is displayed when hibernation occurs to explain how the accuracy of hibernation time can be improved if needed, "Adding option -m can increase the accuracy of the time attributed to hibernation."
  • The Automation_Summary report (generated when using -r auto) now includes summary data for features ia-throt-rsn, gt-throt-rsn, and ring-throt-rsn, as well as other features which contain the table “Summary – Sampled: Counts”.
  • Modified order of feature reports within the summary file to bring relevant data closer together for faster reference.
  • Updated socwatch driver to build for Linux 5.12 (SFI API was removed).


 

Linux* Release Notes Windows* Release Notes

Intel SoC Watch for Windows*

The 2020.5 release (driver v2.14.5) contains these changes:

  • Feature -f hw-cpu-pstate now summarizes and reports CPU P-states per thread (logical processor) rather than per core. The per core summary gave inaccurate results on all new platforms that are running with Hyper-Threading, starting with Intel platform code named Ice Lake. Previously, SoC Watch displayed a warning about inaccurate P-state data and suggested use of –polling option as a work around on those platforms. Additional notes:
    • This change resolves occasional hardware counter correctness issue which resulted in SoC Watch displaying a warning about invalid P-state data because different counters are now used.
    • Added hidden option -f hw-cpu-pstate-per-core to get the old report for use on platforms prior to Ice Lake, where P-state collection per Core is still valid. This feature will report inaccurate results if used on Ice Lake or newer platforms unless the --polling option is included. Note: Features hw-cpu-pstate and hw-cpu-pstate-per-core are mutually exclusive. Attempting to collect both in the same run will result in an error.
  • Changed table names for features -f hw-igfx-cstate and -f hw-igfx-pstate to include "Integrated". Previously, these output tables did not identify the results as Integrated Graphics vs. Discrete Graphics.
  • Support for the following older platforms has been removed in this release: Intel platforms code named Anniedale, Valleyview, Cherry Trail, Haswell, and Broadwell.

Intel SoC Watch for Linux* / Android*

The 2020.5 release (driver v2.13.1) contains these changes:

  • Feature -f hw-cpu-pstate now summarizes and reports CPU P-states per thread (logical processor) rather than per core. The per core summary gave inaccurate results on all new platforms that are running with Hyper-Threading, starting with Intel platform code named Ice Lake. Previously, SoC Watch displayed a warning about inaccurate P-state data and suggested use of –polling option as a work around on those platforms. Additional notes:
    • This change resolves occasional hardware counter correctness issue which resulted in SoC Watch displaying a warning about invalid P-state data because different counters are now used.
    • Added hidden option -f hw-cpu-pstate-per-core to get the old report for use on platforms prior to Ice Lake, where P-state collection per Core is still valid. This feature will report inaccurate results if used on Ice Lake or newer platforms unless the --polling option is included. Note: Features hw-cpu-pstate and hw-cpu-pstate-per-core are mutually exclusive. Attempting to collect both in the same run will result in an error.
  • Changed table names for features -f hw-igfx-cstate and -f hw-igfx-pstate to include "Integrated". Previously, these output tables did not identify the results as Integrated Graphics vs. Discrete Graphics.
  • Support for the following older platforms has been removed in this release: Intel platforms code named Anniedale, Valleyview, Cherry Trail, Haswell, and Broadwell.


 

Known Issue

  1. Intel® oneAPI Toolkits 2022.1.3 and earlier and Intel® Parallel Studio XE (any version) do not support Microsoft Visual Studio 2022. On systems with Microsoft Visual Studio 2022 installed, Intel® oneAPI and Intel® Parallel Studio XE installers may fail during installation, upgrade, modification, or uninstallation. Refer to this article for more information.
  2. YUM/DNF and ZYPPER Packages oneAPI 2021.1 Gold (Initial Release) issue will Prevent Upgrades

Supported Target Operating Systems

Please read the details in Intel® SoC Watch for oneAPI System Requirements.

Previous oneAPI Releases

2022

Notices and Disclaimers

Intel technologies may require enabled hardware, software or service activation.

No product or component can be absolutely secure.

Your costs and results may vary.

© Intel Corporation. Intel, the Intel logo, and other Intel marks are trademarks of Intel Corporation or its subsidiaries. Other names and brands may be claimed as the property of others.

No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document.

The products described may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request.

Intel disclaims all express and implied warranties, including without limitation, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement, as well as any warranty arising from course of performance, course of dealing, or usage in trade.