Skip to content

Latest commit

 

History

History
319 lines (205 loc) · 11 KB

RELEASES.md

File metadata and controls

319 lines (205 loc) · 11 KB
Raw

Release Notes

Unreleased

Added

  • [msr] Support for Emerald Rapids server ("Raptor Cove"), Model 0xCF
  • [msr] Support for Meteor Lake mobile ("Redwood Cove" / "Crestmont"), Model 0xAA

Changed

  • [msr] Updated for the Intel Software Developer's Manual, June 2024 release
  • [rapl-configure] Refactor help output and man page documentation on zones and constraints

Removed

  • [ipg] Remove experimental Intel Power Gadget backend (no longer supported by Microsoft)

Fixed

  • [msr] Incorrect maximum power limit for Sapphire Rapids PSYS zone
  • [msr] Sapphire Rapids and Emerald Rapids use 61 uJ DRAM energy units (per Intel SDM, March 2024 release)
  • [msr] Release builds may get an unused-parameter warning
  • [rapl-configure] Clang may produce embedded-directive warning

v0.9.1 - 2023-11-19

Changed

  • [msr] Updated for the Intel Software Developer's Manual, September 2023 release

Fixed

  • [msr] Support check misses some CPUs: Raptor Lake, Sapphire Rapids, and SoFIA (#14)
  • [powercap] Peak power constraint shouldn't look for a time window (#14)

v0.9.0 - 2023-04-30

Added

  • [msr] Support for Raptor Lake ("Raptor Cove" / "Gracemont"), Model 0xB7
  • [msr] Support for Raptor Lake mobile ("Raptor Cove" / "Gracemont"), Model 0xBA
  • [msr] Support for Raptor Lake client ("Raptor Cove" / "Gracemont"), Model 0xBF
  • [msr] Support for Sapphire Rapids server ("Golden Cove"), Model 0x8F

Changed

  • [msr] Updated for the Intel Software Developer's Manual, March 2023 release

Fixed

  • pkg-config file is broken when CMAKE_INSTALL_{INCLUDE,LIB}DIR is absolute

v0.8.0 - 2022-05-13

Added

  • [msr] Support for Atom Tremont client ("Elkhart Lake"), Model 0x96
  • [msr] Support for Atom Tremont mobile ("Jasper Lake"), Model 0x9C
  • [msr] Support for Alder Lake client ("Golden Cove" / "Gracemont"), Model 0x97
  • [msr] Support for Alder Lake mobile ("Golden Cove" / "Gracemont"), Model 0x9A

Changed

  • [msr] Updated for the Intel Software Developer's Manual, April 2022 release
  • Changes based on previously deprecated behavior:
    • [powercap] Don't fall back on PSYS zone at die=0 and then at pkg=0 when not found for specified pkg/die
  • Internal tweaks based on testing with additional compiler flags

Fixed

  • [msr] Intel SDM incorrectly documents energy status units for Atom Silvermont micro server, Model 0x4D (#13)

v0.7.0 - 2021-12-15

Added

  • CMake package configs
  • CMake installation components
  • [msr] Support for Atom Silvermont micro server ("Avoton" / "Rangeley"), Model 0x4D
  • [powercap] Support for multiple PSYS zones (Linux kernel 5.14 and newer, e.g., for Sapphire Rapids CPUs)

Changed

  • Increased minimum CMake version from 3.6 to 3.12
  • Changes based on previously deprecated behavior:
    • [rapl-configure] Print fully-qualified "watts_long" and "seconds_long" in output for zones with a single constraint
    • [rapl-configure] Don't automatically enable zones - user must explicitly set -e/--enabled=1
    • [rapl-configure] Fail if -W/--watts1 and/or -S/--seconds1 are used but short term constraint is not supported

Deprecated

  • [powercap] Falling back on PSYS zone at die=0 and then at pkg=0 when not found for specified pkg/die - will return an error in the future

Fixed

  • [powercap] Memory leak in 'raplcap_destroy'
  • [rapl-configure] Missing error check when querying for peak power (PL4) constraint support

v0.6.0 - 2021-05-12

Added

  • Support for constraint-specific operations
    • Interface enum 'raplcap_constraint'
    • Interface function 'raplcap_pd_is_constraint_supported'
    • Interface function 'raplcap_pd_get_limit'
    • Interface function 'raplcap_pd_set_limit'
    • [msr] Interface function 'raplcap_msr_pd_is_locked'
    • [msr] Interface function 'raplcap_msr_pd_set_locked'
    • [rapl-configure] New -l/--limit option
    • [rapl-configure] New -t/--time option
    • [rapl-configure] New -p/--power option
  • Support for peak power (PL4) constraint
  • [msr] Support for Tiger Lake, Models 0x8C, 0x8D

Changed

  • Increased minimum CMake version from 2.8.12 to 3.6
  • [msr] Updated for the Intel Software Developer's Manual, November 2020 release

Deprecated

  • Add compiler deprecation attributes to deprecated functions and fields
  • [rapl-configure] Automatic enabling of zones (without an explicit -e/--enabled=1 argument)
  • [rapl-configure] Printing "watts" and "seconds" in output for zones with a single constraint, will use fully-qualified names in the future
  • [rapl-configure] Ignoring -S/--seconds1 and -W/--watts1 options for zones without short term constraints, will be an error in the future

Removed

  • [rapl-configure] Documentation on previously deprecated long options

Fixed

  • [msr] Writing to wrong die MSR in 'raplcap_pd_set_limits', 'raplcap_msr_pd_set_zone_clamped', and 'raplcap_msr_pd_set_zone_locked'
  • [powercap] Library's pkg-config file should specify the minimum powercap dependency version
  • [rapl-configure] Incorrect man page example for disabling a zone

v0.5.0 - 2020-09-02

Added

  • Support for multi-die packages (#9)
    • Interface function 'raplcap_get_num_die'
    • Interface functions 'raplcap_pd_*'
    • [msr] Interface functions 'raplcap_msr_pd_*'
    • [rapl-configure] New -N/--ndie flag
    • [rapl-configure] New -d/--die option
  • Interface function 'raplcap_get_num_packages' (supersedes 'raplcap_get_num_sockets')
  • [msr] Support for Ice Lake, Models 0x7D, 0x7E, 0x6A, 0x6C
  • [msr] Support for Comet Lake, Models 0xA5, 0xA6
  • [rapl-configure] Long option --npackages (supersedes --nsockets)
  • [rapl-configure] Long option --package (supersedes --socket)

Changed

  • Increased minimum CMake version from 2.8.5 to 2.8.12 to support target_compile_definitions
  • [msr] Updated for the Intel Software Developer's Manual, May 2020 release
  • [powercap] Library dependency now requires version >= 0.3.0

Deprecated

  • Functions that are superseded by die-aware ones (#9)
    • Interface functions that are not die-aware, use corresponding 'raplcap_pd_*' functions instead
    • [msr] Interface functions that are not die-aware, use corresponding 'raplcap_msr_pd_*' functions instead
  • Interface function 'raplcap_get_num_sockets', use 'raplcap_get_num_packages' instead
  • Interface struct member 'nsockets', use functions 'raplcap_get_num_packages' and 'raplcap_get_num_die' instead
  • [rapl-configure] Long option --nsockets, use --npackages instead
  • [rapl-configure] Long option --socket, use --package instead

Removed

  • libmsr implementation - the upstream library is no longer being developed

Fixed

  • [powercap] Support for PSYS zones (#8)

v0.4.0 - 2019-12-14

Added

  • [msr] Support for Atom Tremont micro server ("Jacobsville"), Model 0x86
  • [msr] Functions for clamping: 'raplcap_msr_is_zone_clamped' and 'raplcap_msr_set_zone_clamped'
  • [msr] Functions for locking: 'raplcap_msr_is_zone_locked' and 'raplcap_msr_set_zone_locked'
  • [powercap] Support for new "package-X-die-Y" Package zone naming convention in sysfs
  • [powercap] Support for systems with more than 10 packages or dies
  • [rapl-configure] MSR-only support for locked bit status
  • [rapl-configure] MSR-only support for clamping bit status

Changed

  • README: Enable zones in example code snippet (#7)
  • [msr] Updated for the Intel Software Developer's Manual, May 2019 release
  • [rapl-configure] Use consistent output formatting for all zones

Fixed

  • [msr] Fixed #6: Use correct power limit mask (credit: Marc Girard)

v0.3.0 - 2018-06-01

Added

  • MSR implementation support for Atom processors
  • MSR implementation support for Cannon Lake mobile processors
  • Functions for reading energy counters (also added output to rapl-configure binaries)
  • MSR implementation functions to expose time, power, and energy units
  • New -e/--enabled flag for rapl-configure binaries
  • More units tests

Changed

  • MSR implementation will now only compile on x86 (required for RAPL anyway)
  • Cannot disable zones by setting time window or power limit values to 0 in rapl-configure binaries (use -e/--enabled=0 instead)
  • Improved runtime checking for short term constraint support

Fixed

  • Some server processors have DRAM energy units distinct from those specified in the power unit register

v0.2.0 - 2017-12-11

Added

  • Some high-level documentation on RAPL and power capping
  • Simple unit and integration tests

Changed

  • API breakage: Normalized API functions so RAPLCap context is always the first parameter
  • MSR discovery now uses sysfs files instead of parsing /proc/cpuinfo
  • Consistently reset socket count to 0 on destroy or initialization failure
  • Clamping messages reduced from warning to informational
  • Silence error messages when errors are anticipated and handled

Deprecated

  • The libmsr implementation is no longer a primary RAPLCap backend and may be removed in the future

Fixed

  • Enable zones even if clamping can't be set (not available for all zones/platforms)
  • Fixed "raplcap_is_zone_supported" in MSR implementation
  • Only operate on short term constraints in powercap implementation if zone supports it

v0.1.2 - 2017-11-12

Added

  • VERSION and SOVERSION to shared object libraries
  • Multiarch support (use GNU standard installation directories)

Changed

  • Increased minimum CMake version from 2.8 to 2.8.5 to support GNUInstallDirs
  • Updated license to use author as copyright holder
  • Expand man page for rapl-configure binaries
  • Code optimizations

Fixed

  • Sort packages in raplcap-powercap as sysfs entries may be out of order
  • Minor fixes to some log messages

v0.1.1 - 2017-10-02

Added

  • Added man page for rapl-configure binaries

Changed

  • Upstream libmsr removed functionality for PP0/PP1 (core and uncore) zones, so we check for functions during build
  • Try to open files as read-only when possible, but no guarantees
  • Build improvements

Fixed

  • Fixed possible crash with getopt in rapl-configure binaries

v0.1.0 - 2017-06-09

Added

  • Initial public release