diff --git a/CMakeLists.txt b/CMakeLists.txt index ac1d2738..2a245f0c 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -120,9 +120,9 @@ if(UNIX) set(CPACK_PACKAGE_NAME "pcm") set(CPACK_PACKAGE_VERSION "0000") - set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Processor Counter Monitor (PCM)") + set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "Intel(r) Performance Counter Monitor (Intel(r) PCM)") set(CPACK_PACKAGE_DESCRIPTION "\ - Processor Counter Monitor (PCM) is an application programming\n\ + Intel(r) Performance Counter Monitor (Intel(r) PCM) is an application programming\n\ interface (API) and a set of tools based on the API to monitor\n\ performance and energy metrics of Intel(r) Core(tm), Xeon(r), Atom(tm)\n\ and Xeon Phi(tm) processors. PCM works on Linux, Windows, Mac OS X,\n\ diff --git a/Doxyfile b/Doxyfile index b3fb00c5..09086353 100644 --- a/Doxyfile +++ b/Doxyfile @@ -17,7 +17,7 @@ # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. -PROJECT_NAME = "Processor Counter Monitor" +PROJECT_NAME = "Intel(r) Performance Counter Monitor" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or diff --git a/README.md b/README.md index bd16d99b..096874d7 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -------------------------------------------------------------------------------- -Processor Counter Monitor (PCM) +Intel® Performance Counter Monitor (Intel® PCM) -------------------------------------------------------------------------------- [PCM Tools](#pcm-tools) | [Building PCM](#building-pcm-tools) | [Downloading Pre-Compiled PCM](#downloading-pre-compiled-pcm-tools) | [FAQ](#frequently-asked-questions-faq) | [API Documentation](#pcm-api-documentation) | [Environment Variables](#pcm-environment-variables) | [Compilation Options](#custom-compilation-options) -Processor Counter Monitor (PCM) is an application programming interface (API) and a set of tools based on the API to monitor performance and energy metrics of Intel® Core™, Xeon®, Atom™ and Xeon Phi™ processors. PCM works on Linux, Windows, Mac OS X, FreeBSD, DragonFlyBSD and ChromeOS operating systems. +Intel® Performance Counter Monitor (Intel® PCM) is an application programming interface (API) and a set of tools based on the API to monitor performance and energy metrics of Intel® Core™, Xeon®, Atom™ and Xeon Phi™ processors. PCM works on Linux, Windows, Mac OS X, FreeBSD, DragonFlyBSD and ChromeOS operating systems. *Github repository statistics:* ![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fhetthbszh0.execute-api.us-east-2.amazonaws.com%2Fdefault%2Fpcm-clones) ![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2F5urjfrshcd.execute-api.us-east-2.amazonaws.com%2Fdefault%2Fpcm-yesterday-clones) ![Custom badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fcsqqh18g3l.execute-api.us-east-2.amazonaws.com%2Fdefault%2Fpcm-today-clones) diff --git a/doc/DOCKER_README.md b/doc/DOCKER_README.md index 05d3b06a..a295d9a7 100644 --- a/doc/DOCKER_README.md +++ b/doc/DOCKER_README.md @@ -1,5 +1,5 @@ -------------------------------------------------------------------------------- -How To Run Processor Counter Monitor Server Container from GitHub Container Repository or Docker Hub +How To Run Intel(r) Performance Counter Monitor Server Container from GitHub Container Repository or Docker Hub -------------------------------------------------------------------------------- As root user: diff --git a/doc/PCM-EXPORTER.md b/doc/PCM-EXPORTER.md index 64ae83a1..b68f69a8 100644 --- a/doc/PCM-EXPORTER.md +++ b/doc/PCM-EXPORTER.md @@ -1,4 +1,4 @@ -# Processor Counter Monitor (PCM) Prometheus exporter [![Build Status](https://travis-ci.com/opcm/pcm.svg?branch=master)](https://travis-ci.com/opcm/pcm) +# Intel® Performance Counter Monitor (Intel® PCM) Prometheus exporter [![Build Status](https://travis-ci.com/opcm/pcm.svg?branch=master)](https://travis-ci.com/opcm/pcm) pcm-sensor-server is a collector exposing Intel processor metrics over http in JSON or Prometheus (exporter text based) format. Also [available as a docker container](DOCKER_README.md). diff --git a/pcm.spec b/pcm.spec index e6f6cf72..0b0d6d22 100644 --- a/pcm.spec +++ b/pcm.spec @@ -2,7 +2,7 @@ Name: pcm Version: 0 Release: 0 -Summary: Processor Counter Monitor +Summary: Intel(r) Performance Counter Monitor Group: System/Monitoring License: BSD-3-Clause Url: https://github.com/opcm/pcm/archive @@ -17,7 +17,7 @@ BuildRequires: cmake %description -Processor Counter Monitor (PCM) is an application programming interface (API) and a set of tools based on the API to monitor performance and energy metrics of Intel(r) Core(tm), Xeon(r), Atom(tm) and Xeon Phi(tm) processors. PCM works on Linux, Windows, Mac OS X, FreeBSD and DragonFlyBSD operating systems. +Intel(r) Performance Counter Monitor (Intel(r) PCM) is an application programming interface (API) and a set of tools based on the API to monitor performance and energy metrics of Intel(r) Core(tm), Xeon(r), Atom(tm) and Xeon Phi(tm) processors. PCM works on Linux, Windows, Mac OS X, FreeBSD and DragonFlyBSD operating systems. %prep %setup -n pcm-master diff --git a/scripts/grafana/README.md b/scripts/grafana/README.md index 5a25e189..1af4e3db 100644 --- a/scripts/grafana/README.md +++ b/scripts/grafana/README.md @@ -21,7 +21,7 @@ Installation of the grafana front-end (can be on any *host* system with connecti - `start.sh` script starts telegraf/influxdb/grafana containers - `start-prometheus.sh` is an alternative script which starts prometheus + grafana containers: `sudo sh start-prometheus.sh target_system_address:9738` - Don't use `localhost` to specify the `target_system_address` if the *host* and the target are the same machine because `localhost` resolves to the own private IP address of the docker container when accessed inside the container. The external IP address or hostname should be used instead. -4. Start your browser at http://*host*:3000/ and then login with admin user, password admin . Change the password and then click on "**Home**" (left top corner) -> "Processor Counter Monitor (PCM) Dashboard" +4. Start your browser at http://*host*:3000/ and then login with admin user, password admin . Change the password and then click on "**Home**" (left top corner) -> "Intel® Performance Counter Monitor (Intel® PCM) Dashboard" 5. You can also stop and delete the containers when needed: `sudo sh stop.sh` ![pcm grafana output](https://raw.githubusercontent.com/wiki/opcm/pcm/pcm-dashboard-full.png) diff --git a/src/cpucounters.cpp b/src/cpucounters.cpp index e76e37c9..ab27b6ca 100644 --- a/src/cpucounters.cpp +++ b/src/cpucounters.cpp @@ -2934,10 +2934,10 @@ void PCM::checkError(const PCM::ErrorCode code) case PCM::Success: break; case PCM::MSRAccessDenied: - std::cerr << "Access to Processor Counter Monitor has denied (no MSR or PCI CFG space access).\n"; + std::cerr << "Access to Intel(r) Performance Counter Monitor has denied (no MSR or PCI CFG space access).\n"; exit(EXIT_FAILURE); case PCM::PMUBusy: - std::cerr << "Access to Processor Counter Monitor has denied (Performance Monitoring Unit is occupied by other application)\n"; + std::cerr << "Access to Intel(r) Performance Counter Monitor has denied (Performance Monitoring Unit is occupied by other application)\n"; std::cerr << "Try to stop the application that uses PMU, or reset PMU configuration from PCM application itself\n"; std::cerr << "You can try to reset PMU configuration now. Try to reset? (y/n)\n"; char yn; @@ -2949,7 +2949,7 @@ void PCM::checkError(const PCM::ErrorCode code) } exit(EXIT_FAILURE); default: - std::cerr << "Access to Processor Counter Monitor has denied (Unknown error).\n"; + std::cerr << "Access to Intel(r) Performance Counter Monitor has denied (Unknown error).\n"; exit(EXIT_FAILURE); } } diff --git a/src/dashboard.cpp b/src/dashboard.cpp index fe4fc5e1..1ccfe6d2 100644 --- a/src/dashboard.cpp +++ b/src/dashboard.cpp @@ -532,7 +532,7 @@ std::string getPCMDashboardJSON(const PCMDashboardType type, int ns, int nu, int { hostname = buffer; } - Dashboard dashboard("Processor Counter Monitor (PCM) Dashboard - " + hostname); + Dashboard dashboard("Intel(r) Performance Counter Monitor (Intel(r) PCM) Dashboard - " + hostname); auto createTarget = [type](const std::string& title, const std::string& inluxdbMetric, const std::string& prometheusExpr) -> std::shared_ptr { std::shared_ptr t; diff --git a/src/pcm-core.cpp b/src/pcm-core.cpp index 1aab41f5..95be1f5b 100644 --- a/src/pcm-core.cpp +++ b/src/pcm-core.cpp @@ -271,7 +271,7 @@ int main(int argc, char * argv[]) set_signal_handlers(); cerr << "\n"; - cerr << " Processor Counter Monitor: Core Monitoring Utility \n"; + cerr << " Intel(r) Performance Counter Monitor: Core Monitoring Utility \n"; cerr << "\n"; double delay = -1.0; diff --git a/src/pcm-iio.cpp b/src/pcm-iio.cpp index 7a34d16e..c5782d0c 100644 --- a/src/pcm-iio.cpp +++ b/src/pcm-iio.cpp @@ -1153,7 +1153,7 @@ int main(int argc, char * argv[]) set_signal_handlers(); - std::cout << "\n Processor Counter Monitor " << PCM_VERSION << "\n"; + std::cout << "\n Intel(r) Performance Counter Monitor " << PCM_VERSION << "\n"; std::cout << "\n This utility measures Skylake-SP IIO information\n\n"; string program = string(argv[0]); diff --git a/src/pcm-latency.cpp b/src/pcm-latency.cpp index 95ce3b1f..0a901170 100644 --- a/src/pcm-latency.cpp +++ b/src/pcm-latency.cpp @@ -466,7 +466,7 @@ int main(int argc, char * argv[]) set_signal_handlers(); - std::cout << "\n Processor Counter Monitor " << PCM_VERSION << "\n"; + std::cout << "\n Intel(r) Performance Counter Monitor " << PCM_VERSION << "\n"; std::cout << "\n This utility measures Latency information\n\n"; bool enable_pmm = false; bool enable_verbose = false; diff --git a/src/pcm-memory.cpp b/src/pcm-memory.cpp index 165bee0b..d2bf536f 100644 --- a/src/pcm-memory.cpp +++ b/src/pcm-memory.cpp @@ -978,7 +978,7 @@ int main(int argc, char * argv[]) set_signal_handlers(); cerr << "\n"; - cerr << " Processor Counter Monitor: Memory Bandwidth Monitoring Utility " << PCM_VERSION << "\n"; + cerr << " Intel(r) Performance Counter Monitor: Memory Bandwidth Monitoring Utility " << PCM_VERSION << "\n"; cerr << "\n"; cerr << " This utility measures memory bandwidth per channel or per DIMM rank in real-time\n"; diff --git a/src/pcm-mmio.cpp b/src/pcm-mmio.cpp index 77c22d01..322e923d 100644 --- a/src/pcm-mmio.cpp +++ b/src/pcm-mmio.cpp @@ -50,7 +50,7 @@ void doOp(const uint64 address, const uint64 offset, const bool write, T value, int main(int argc, char * argv[]) { - std::cout << "\n Processor Counter Monitor " << PCM_VERSION << "\n"; + std::cout << "\n Intel(r) Performance Counter Monitor " << PCM_VERSION << "\n"; std::cout << "\n MMIO register read/write utility\n\n"; diff --git a/src/pcm-msr.cpp b/src/pcm-msr.cpp index 20039a9a..9f9492d6 100644 --- a/src/pcm-msr.cpp +++ b/src/pcm-msr.cpp @@ -32,7 +32,7 @@ void print_usage(const char * progname) int main(int argc, char * argv[]) { - std::cout << "\n Processor Counter Monitor " << PCM_VERSION << "\n"; + std::cout << "\n Intel(r) Performance Counter Monitor " << PCM_VERSION << "\n"; std::cout << "\n MSR read/write utility\n\n"; diff --git a/src/pcm-numa.cpp b/src/pcm-numa.cpp index 77dc40df..67435e3e 100644 --- a/src/pcm-numa.cpp +++ b/src/pcm-numa.cpp @@ -99,7 +99,7 @@ int main(int argc, char * argv[]) set_signal_handlers(); cerr << "\n"; - cerr << " Processor Counter Monitor: NUMA monitoring utility \n"; + cerr << " Intel(r) Performance Counter Monitor: NUMA monitoring utility \n"; cerr << "\n"; double delay = -1.0; diff --git a/src/pcm-pcicfg.cpp b/src/pcm-pcicfg.cpp index 404d1373..a4791c36 100644 --- a/src/pcm-pcicfg.cpp +++ b/src/pcm-pcicfg.cpp @@ -30,7 +30,7 @@ void print_usage(const char * progname) int main(int argc, char * argv[]) { - std::cout << "\n Processor Counter Monitor " << PCM_VERSION << "\n"; + std::cout << "\n Intel(r) Performance Counter Monitor " << PCM_VERSION << "\n"; std::cout << "\n PCICFG read/write utility\n\n"; diff --git a/src/pcm-pcie.cpp b/src/pcm-pcie.cpp index 90e06267..835baffe 100644 --- a/src/pcm-pcie.cpp +++ b/src/pcm-pcie.cpp @@ -124,7 +124,7 @@ int main(int argc, char * argv[]) set_signal_handlers(); cerr << "\n"; - cerr << " Processor Counter Monitor: PCIe Bandwidth Monitoring Utility \n"; + cerr << " Intel(r) Performance Counter Monitor: PCIe Bandwidth Monitoring Utility \n"; cerr << " This utility measures PCIe bandwidth in real-time\n"; cerr << "\n"; print_events(); diff --git a/src/pcm-power.cpp b/src/pcm-power.cpp index 6f8177a8..8f60742e 100644 --- a/src/pcm-power.cpp +++ b/src/pcm-power.cpp @@ -138,7 +138,7 @@ int main(int argc, char * argv[]) set_signal_handlers(); - cerr << "\n Processor Counter Monitor " << PCM_VERSION << "\n"; + cerr << "\n Intel(r) Performance Counter Monitor " << PCM_VERSION << "\n"; cerr << "\n Power Monitoring Utility\n"; int imc_profile = 0; diff --git a/src/pcm-raw.cpp b/src/pcm-raw.cpp index 97fce9e1..4a859189 100644 --- a/src/pcm-raw.cpp +++ b/src/pcm-raw.cpp @@ -1827,7 +1827,7 @@ int main(int argc, char* argv[]) set_real_time_priority(true); cerr << "\n"; - cerr << " Processor Counter Monitor: Raw Event Monitoring Utility \n"; + cerr << " Intel(r) Performance Counter Monitor: Raw Event Monitoring Utility \n"; cerr << "\n"; std::vector PMUConfigs(1); diff --git a/src/pcm-tsx.cpp b/src/pcm-tsx.cpp index ecd7ebfd..b80969c9 100644 --- a/src/pcm-tsx.cpp +++ b/src/pcm-tsx.cpp @@ -270,7 +270,7 @@ int main(int argc, char * argv[]) cerr << "\n"; - cerr << " Processor Counter Monitor: Intel(r) Transactional Synchronization Extensions Monitoring Utility \n"; + cerr << " Intel(r) Performance Counter Monitor: Intel(r) Transactional Synchronization Extensions Monitoring Utility \n"; cerr << "\n"; double delay = -1.0; diff --git a/src/pcm.cpp b/src/pcm.cpp index 42433e94..8154bbd5 100644 --- a/src/pcm.cpp +++ b/src/pcm.cpp @@ -1146,7 +1146,7 @@ int main(int argc, char * argv[]) set_signal_handlers(); cerr << "\n"; - cerr << " Processor Counter Monitor " << PCM_VERSION << "\n"; + cerr << " Intel(r) Performance Counter Monitor " << PCM_VERSION << "\n"; cerr << "\n"; cerr << "\n"; @@ -1329,14 +1329,14 @@ int main(int argc, char * argv[]) case PCM::Success: break; case PCM::MSRAccessDenied: - cerr << "Access to Processor Counter Monitor has denied (no MSR or PCI CFG space access).\n"; + cerr << "Access to Intel(r) Performance Counter Monitor has denied (no MSR or PCI CFG space access).\n"; exit(EXIT_FAILURE); case PCM::PMUBusy: - cerr << "Access to Processor Counter Monitor has denied (Performance Monitoring Unit is occupied by other application). Try to stop the application that uses PMU.\n"; + cerr << "Access to Intel(r) Performance Counter Monitor has denied (Performance Monitoring Unit is occupied by other application). Try to stop the application that uses PMU.\n"; cerr << "Alternatively you can try running PCM with option -r to reset PMU.\n"; exit(EXIT_FAILURE); default: - cerr << "Access to Processor Counter Monitor has denied (Unknown error).\n"; + cerr << "Access to Intel(r) Performance Counter Monitor has denied (Unknown error).\n"; exit(EXIT_FAILURE); } diff --git a/src/windows/PCMInstaller.h b/src/windows/PCMInstaller.h index b8af4026..c6a3c959 100644 --- a/src/windows/PCMInstaller.h +++ b/src/windows/PCMInstaller.h @@ -72,7 +72,7 @@ namespace PMUService { this->serviceInstaller1->Description = L"This service provides performance counters for perfmon to show hardware events ov" L"er time such as Clockticks, Instruction Retired, Cache Misses and Memory Bandwi" L"dth."; - this->serviceInstaller1->DisplayName = L"Processor Counter Monitor Service"; + this->serviceInstaller1->DisplayName = L"Intel(r) Performance Counter Monitor Service"; this->serviceInstaller1->ServiceName = L"PCMService"; this->serviceInstaller1->StartType = System::ServiceProcess::ServiceStartMode::Automatic; // diff --git a/src/windows/PCMService.h b/src/windows/PCMService.h index f912a827..354519c3 100755 --- a/src/windows/PCMService.h +++ b/src/windows/PCMService.h @@ -140,7 +140,7 @@ namespace PCMServiceNS { counterCollection->Add( counter ); counter = gcnew CounterCreationData(MetricCoreResC7Base, "", PerformanceCounterType::RawBase); counterCollection->Add(counter); - PerformanceCounterCategory::Create(CountersCore, "Processor Counter Monitor", PerformanceCounterCategoryType::MultiInstance, counterCollection); + PerformanceCounterCategory::Create(CountersCore, "Intel(r) Performance Counter Monitor", PerformanceCounterCategoryType::MultiInstance, counterCollection); } if (collectionInformation_->socket) @@ -186,7 +186,7 @@ namespace PCMServiceNS { counterCollection->Add( counter ); counter = gcnew CounterCreationData(MetricSocketResC10Base, "", PerformanceCounterType::RawBase); counterCollection->Add(counter); - PerformanceCounterCategory::Create(CountersSocket, "Processor Counter Monitor", PerformanceCounterCategoryType::MultiInstance, counterCollection); + PerformanceCounterCategory::Create(CountersSocket, "Intel(r) Performance Counter Monitor", PerformanceCounterCategoryType::MultiInstance, counterCollection); } if (collectionInformation_->qpi) @@ -194,7 +194,7 @@ namespace PCMServiceNS { counterCollection->Clear(); counter = gcnew CounterCreationData(MetricQpiBand, L"Displays the incoming bandwidth in bytes/s of this " + gcnew System::String(m_->xPI()) + L" link", PerformanceCounterType::CounterDelta64); counterCollection->Add( counter ); - PerformanceCounterCategory::Create(CountersQpi, "Processor Counter Monitor", PerformanceCounterCategoryType::MultiInstance, counterCollection); + PerformanceCounterCategory::Create(CountersQpi, "Intel(r) Performance Counter Monitor", PerformanceCounterCategoryType::MultiInstance, counterCollection); } log_->WriteEntry(Globals::ServiceName, "New categories added.");