pcm

---

Intel® 性能计数器监视器 (Intel® PCM)

PCM 工具 | 构建 PCM | 下载预编译 PCM | 常见问题 | API 文档 | 环境变量 | 编译选项

Intel® 性能计数器监视器 (Intel® PCM) 是一个应用程序编程接口 (API) 和一套基于该 API 的工具，用于监控 Intel® Core™、Xeon®、Atom™ 和 Xeon Phi™ 处理器的性能和能耗指标。PCM 可在 Linux、Windows、Mac OS X、FreeBSD、DragonFlyBSD 和 ChromeOS 操作系统上运行。

Github 仓库统计：

我们欢迎提交 bug 报告和功能增强请求，可以通过 GitHub 的"Issues"部分提交。对于有兴趣为代码贡献的人，请参考 CONTRIBUTING.md 文件中概述的指南。

---

当前构建状态

• Linux:
• Windows:
• FreeBSD:
• OS X:
• Docker 容器:

---

PCM 工具

PCM 提供了多个命令行实用工具，用于实时监控：

• pcm：基本处理器监控工具（每周期指令数、核心频率（包括 Intel(r) Turbo Boost 技术）、内存和 Intel(r) Quick Path Interconnect 带宽、本地和远程内存带宽、缓存未命中、核心和 CPU 包睡眠 C-state 占用率、核心和 CPU 包热余量、缓存利用率、CPU 和内存能耗）

• pcm-sensor-server：pcm 收集器，通过 http 以 JSON 或 Prometheus（导出器文本）格式公开指标（使用方法。也可作为 docker 容器 使用。有关全局 PCM 事件的更多信息在这里。

• pcm-memory：监控内存带宽（每通道和每 DRAM DIMM 等级）

• pcm-accel：监控 Intel® 内存分析加速器 (Intel® IAA)、Intel® 数据流加速器 (Intel® DSA) 和 Intel® QuickAssist 技术 (Intel® QAT) 加速器

• pcm-latency：监控 L1 缓存未命中和 DDR/PMM 内存延迟

• pcm-pcie：监控每个插槽的 PCIe 带宽

• pcm-iio：监控每个 PCIe 设备的 PCIe 带宽

• pcm-numa：监控本地和远程内存访问
• pcm-power：监控处理器、Intel(r) Quick Path Interconnect、DRAM 内存的睡眠和能源状态，CPU 频率限制的原因以及其他能源相关指标
• pcm-tsx：监控 Intel(r) 事务同步扩展的性能指标
• pcm-core 和 pmu-query：查询和监控任意处理器核心事件
• pcm-raw：通过指定原始寄存器事件 ID 编码来编程任意核心和非核心事件
• pcm-bw-histogram：收集内存带宽利用率直方图

图形化前端：

• pcm Grafana 仪表板：Grafana 的前端（在 scripts/grafana 目录中）。完整的 Grafana 说明在这里
• pcm-sensor：KDE KSysGuard 的前端
• pcm-service：Windows perfmon 的前端

还有用于读取/写入特定模型寄存器（pcm-msr）、PCI 配置寄存器（pcm-pcicfg）、内存映射寄存器（pcm-mmio）和 TPMI 寄存器（pcm-tpmi）的工具，支持 Linux、Windows、Mac OS X 和 FreeBSD。

最后还有一个守护进程，它将核心、内存和 QPI 计数器存储在共享内存中，可以被非root用户访问。

---

构建 PCM 工具

克隆 PCM 仓库及其子模块：

git clone --recursive https://github.com/intel/pcm.git

或者先克隆仓库，然后更新子模块：

git submodule update --init --recursive

安装 cmake，然后：

mkdir build
cd build
cmake ..
cmake --build .

你将在 build/bin 目录中获得所有工具（pcm、pcm-memory 等）。 可以使用 '--parallel' 进行更快的构建：

cmake --build . --parallel

在 Windows 和 MacOS 上，默认为 Debug 构建。指定配置以构建 Release 版本：

cmake --build . --config Release

在 Windows 和 MacOS 上需要额外的驱动程序和步骤。请在这里找到说明：WINDOWS_HOWTO.md 和 MAC_HOWTO.txt。

FreeBSD/DragonFlyBSD 特定的详细信息可以在 FREEBSD_HOWTO.txt 中找到。

---

下载预编译的PCM工具

• Linux:
  • Ubuntu/Debian: sudo apt install pcm
  • openSUSE: sudo zypper install pcm
  • RHEL8.5或更高版本: sudo dnf install pcm
  • Fedora: sudo yum install pcm
  • RHEL/SLE/Ubuntu/Debian/openSUSE等发行版的最新PCM版本RPM和DEB包（二进制和源代码）可在此处获取
• Windows: 从appveyor构建服务下载PCM二进制文件作为构建产物，并从www.microsoft.com下载所需的Visual C++可再发行组件。需要额外的步骤和驱动程序，请参阅WINDOWS_HOWTO.md。
• Docker: 请参阅如何使用来自Docker Hub的预编译pcm-sensor-server容器的说明。

---

在Linux上以非root用户执行PCM工具

在Linux操作系统上以非特权用户执行PCM工具是可行的。但是，需要满足某些先决条件，例如在当前运行的Linux内核版本中为您的处理器提供Linux perf_event支持。要成功运行PCM工具，您需要以root身份将/proc/sys/kernel/perf_event_paranoid设置为-1（仅需一次）：

echo -1 > /proc/sys/kernel/perf_event_paranoid

并在以非root用户运行工具时配置两个特定的环境变量：

export PCM_NO_MSR=1
export PCM_KEEP_NMI_WATCHDOG=1

例如，您可以执行以下命令来设置环境变量并运行pcm：

export PCM_NO_MSR=1
export PCM_KEEP_NMI_WATCHDOG=1
pcm

或者（以非root身份运行pcm传感器服务器）：

PCM_NO_MSR=1 PCM_KEEP_NMI_WATCHDOG=1 pcm-sensor-server

请注意，在Linux上以非特权用户执行PCM工具时，某些PCM指标可能无法使用。这一限制特别影响仅依赖直接MSR（模型特定寄存器）寄存器访问的指标。由于用户权限受限，无法访问这些寄存器，导致相应的指标缺失。

---

常见问题解答（FAQ）

PCM的常见问题解答（FAQ）位于此处。

---

PCM API文档

PCM API文档嵌入在源代码中，可以使用Doxygen（www.doxygen.org）从源代码生成html格式。

---

PCM环境变量

PCM环境变量列表位于此处。

---

自定义编译选项

自定义编译选项列表位于此处。

---

打包

使用CPack支持在Debian和Redhat/SUSE系统家族上进行打包。 要创建DEB或RPM包，需要在构建文件夹中构建后调用cpack：

cd build
cpack

这将创建以下包：

• Debian系统家族上的"pcm-VERSION-Linux.deb"；
• Redhat/SUSE系统家族上的"pcm-VERSION-Linux.rpm"。 包含pcm-*二进制文件和使用所需的opCode-*文件。