pcm-raw: implement -out switch to print all stderr/stdout to a file

Change-Id: I1377146c412d9015ba70bbe323c770cc43f988fe

Author: rdementi

src/cpucounters.cpp

@@ -2173,6 +2173,10 @@ class CoreTaskQueue
     }
 };
 
+std::ofstream* PCM::outfile = nullptr;       // output file stream
+std::streambuf* PCM::backup_ofile = nullptr; // backup of original output = cout
+std::streambuf* PCM::backup_ofile_cerr = nullptr; // backup of original output = cerr
+
 PCM::PCM() :
     cpu_family(-1),
     cpu_model(-1),
@@ -2229,8 +2233,6 @@ PCM::PCM() :
     mode(INVALID_MODE),
     numInstancesSemaphore(NULL),
     canUsePerf(false),
-    outfile(NULL),
-    backup_ofile(NULL),
     run_state(1),
     needToRestoreNMIWatchdog(false)
 {
@@ -4044,11 +4046,16 @@ void PCM::cleanupRDT(const bool silent)
     if (!silent) std::cerr << " Freeing up all RMIDs\n";
 }
 
-void PCM::setOutput(const std::string filename)
+void PCM::setOutput(const std::string filename, const bool cerrToo)
 {
      outfile = new std::ofstream(filename.c_str());
      backup_ofile = std::cout.rdbuf();
      std::cout.rdbuf(outfile->rdbuf());
+     if (cerrToo)
+     {
+         backup_ofile_cerr = std::cerr.rdbuf();
+         std::cerr.rdbuf(outfile->rdbuf());
+     }
 }
 
 void PCM::restoreOutput()
@@ -4057,6 +4064,9 @@ void PCM::restoreOutput()
     if(backup_ofile)
         std::cout.rdbuf(backup_ofile);
 
+    if (backup_ofile_cerr)
+        std::cerr.rdbuf(backup_ofile_cerr);
+
 // close output file
     if(outfile)
         outfile->close();

src/cpucounters.h

@@ -675,8 +675,8 @@ class PCM_API PCM
         return (pkgCStateMsr != NULL && state <= ((int)MAX_C_STATE) && pkgCStateMsr[state] != 0);
     }
 
-    //! \brief Redirects output destination to provided file, instead of std::cout
-    void setOutput(const std::string filename);
+    //! \brief Redirects output destination to provided file, instead of std::cout and std::cerr (optional)
+    static void setOutput(const std::string filename, const bool cerrToo = false);
 
     //! \brief Restores output, closes output file if opened
     void restoreOutput();
@@ -898,8 +898,9 @@ class PCM_API PCM
         PERF_TOPDOWN_GROUP_LEADER_COUNTER = PERF_TOPDOWN_SLOTS_POS
     };
 #endif
-    std::ofstream * outfile;       // output file stream
-    std::streambuf * backup_ofile; // backup of original output = cout
+    static std::ofstream * outfile;       // output file stream
+    static std::streambuf * backup_ofile; // backup of original output = cout
+    static std::streambuf * backup_ofile_cerr; // backup of original output = cerr
     int run_state;                 // either running (1) or sleeping (0)
 
     bool needToRestoreNMIWatchdog;

src/pcm-raw.cpp

@@ -59,10 +59,11 @@ 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 << "  -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";
-    cerr << "  [-e event1] [-e event2] [-e event3] .. => list of custom events to monitor\n";
+    cerr << "  -out filename       | /out filename    => write all output (stdout and stderr) to specified file\n";
     cerr << "  event description example: -e core/config=0x30203,name=LD_BLOCKS.STORE_FORWARD/ -e core/fixed,config=0x333/ \n";
     cerr << "                             -e cha/config=0,name=UNC_CHA_CLOCKTICKS/ -e imc/fixed,name=DRAM_CLOCKS/\n";
 #ifdef PCM_SIMDJSON_AVAILABLE
@@ -1732,6 +1733,13 @@ int main(int argc, char* argv[])
 {
     set_signal_handlers();
 
+    parseParam(argc, argv, "out", [](const char* p) {
+            const string filename{ p };
+            if (!filename.empty()) {
+                PCM::setOutput(filename, true);
+            }
+        });
+
 #ifdef PCM_FORCE_SILENT
     null_stream nullStream1, nullStream2;
     std::cout.rdbuf(&nullStream1);
@@ -1851,6 +1859,12 @@ int main(int argc, char* argv[])
             }
             continue;
         }
+        else if (strncmp(*argv, "-out", 4) == 0 || strncmp(*argv, "/out", 4) == 0)
+        {
+            argv++;
+            argc--;
+            continue;
+        }
         else if (strncmp(*argv, "-ep", 3) == 0 || strncmp(*argv, "/ep", 3) == 0)
         {
             argv++;