pcm-raw: add collection of core events for process ID

Author: rdementi

src/cpucounters.cpp

@@ -4583,7 +4583,7 @@ void PCM::programPCU(uint32* PCUCntConf, const uint64 filter)
     }
 }
 
-PCM::ErrorCode PCM::program(const RawPMUConfigs& curPMUConfigs_, const bool silent)
+PCM::ErrorCode PCM::program(const RawPMUConfigs& curPMUConfigs_, const bool silent, const int pid)
 {
     if (MSR.empty())  return PCM::MSRAccessDenied;
     threadMSRConfig = RawPMUConfig{};
@@ -4638,7 +4638,7 @@ PCM::ErrorCode PCM::program(const RawPMUConfigs& curPMUConfigs_, const bool sile
         }
         conf.defaultUncoreProgramming = false;
 
-        const auto status = program(PCM::EXT_CUSTOM_CORE_EVENTS, &conf, silent);
+        const auto status = program(PCM::EXT_CUSTOM_CORE_EVENTS, &conf, silent, pid);
         if (status != PCM::Success)
         {
             return status;

src/cpucounters.h

@@ -1187,7 +1187,7 @@ class PCM_API PCM
         FrontendPos = 4
     };
     typedef std::map<std::string, RawPMUConfig> RawPMUConfigs;
-    ErrorCode program(const RawPMUConfigs& curPMUConfigs, const bool silent = false);
+    ErrorCode program(const RawPMUConfigs& curPMUConfigs, const bool silent = false, const int pid = -1);
 
     std::pair<unsigned, unsigned> getOCREventNr(const int event, const unsigned coreID) const
     {

src/pcm-raw.cpp

@@ -58,7 +58,8 @@ void print_usage(const string progname)
     cerr << "                                            will read counters only after external program finishes\n";
     cerr << " Supported <options> are: \n";
     cerr << "  -h    | --help      | /h               => print this help and exit\n";
-    cerr << "  -e event1 [-e event2] [-e event3] .. => list of custom events to monitor\n";
+    cerr << "  -e event1 [-e event2] [-e event3] ..   => list of custom events to monitor\n";
+    cerr << "  -pid PID | /pid PID                    => collect core metrics only for specified process ID\n";
     cerr << "  -r    | --reset     | /reset           => reset PMU configuration (at your own risk)\n";
     cerr << "  -csv[=file.csv]     | /csv[=file.csv]  => output compact CSV format to screen or\n"
          << "                                            to a file, in case filename is provided\n";
@@ -1786,6 +1787,7 @@ int main(int argc, char* argv[])
 
     std::vector<PCM::RawPMUConfigs> PMUConfigs(1);
     double delay = -1.0;
+    int pid{-1};
     char* sysCmd = NULL;
     char** sysArgv = NULL;
     MainLoop mainLoop;
@@ -1794,6 +1796,8 @@ int main(int argc, char* argv[])
     bool reset_pmu = false;
     PCM* m = PCM::getInstance();
 
+    parseParam(argc, argv, "pid", [&pid](const char* p) { if (p) pid = atoi(p); });
+
 #ifdef PCM_SIMDJSON_AVAILABLE
     parseParam(argc, argv, "ep", [](const char* p) { eventFileLocationPrefix = p;});
 #endif
@@ -1826,7 +1830,13 @@ int main(int argc, char* argv[])
         {
             continue;
         }
-        if (strncmp(*argv, "-reset", 6) == 0 ||
+        else if (strncmp(*argv, "-pid", 4) == 0 || strncmp(*argv, "/pid", 4) == 0)
+        {
+            argv++;
+            argc--;
+            continue;
+        }
+        else if (strncmp(*argv, "-reset", 6) == 0 ||
             strncmp(*argv, "-r", 2) == 0 ||
             strncmp(*argv, "/reset", 6) == 0)
         {
@@ -2031,7 +2041,9 @@ int main(int argc, char* argv[])
         cerr << "Enforcing transposed event output because the number of event groups > 1\n";
     }
 
-    auto programPMUs = [&m](const PCM::RawPMUConfigs & config)
+    print_pid_collection_message(pid);
+
+    auto programPMUs = [&m, &pid](const PCM::RawPMUConfigs & config)
     {
         if (verbose)
         {
@@ -2047,7 +2059,7 @@ int main(int argc, char* argv[])
                 }
             }
         }
-        PCM::ErrorCode status = m->program(config, !verbose);
+        PCM::ErrorCode status = m->program(config, !verbose, pid);
         m->checkError(status);
     };
 

src/pcm.cpp

@@ -1376,10 +1376,7 @@ int main(int argc, char * argv[])
     SystemCounterState sstate1, sstate2;
     const auto cpu_model = m->getCPUModel();
 
-    if (pid != -1)
-    {
-        cerr << "Collecting core metrics for process ID " << pid << "\n";
-    }
+    print_pid_collection_message(pid);
 
     if ((sysCmd != NULL) && (delay <= 0.0)) {
         // in case external command is provided in command line, and

src/utils.cpp

@@ -671,6 +671,14 @@ std::string safe_getenv(const char* env)
 }
 #endif
 
+void print_pid_collection_message(int pid)
+{
+    if (pid != -1)
+    {
+        std::cerr << "Collecting core metrics for process ID " << std::dec << pid << "\n";
+    }
+}
+
 void check_and_set_silent(int argc, char * argv[], null_stream &nullStream2) {
     if (argc > 1) do
     {

src/utils.h

@@ -496,4 +496,6 @@ inline HANDLE openMSRDriver()
 // silence all following err output
 void check_and_set_silent(int argc, char * argv[], null_stream &nullStream2);
 
+void print_pid_collection_message(int pid);
+
 } // namespace pcm