Merge pull request #47477 from makortel/optionalEdmProvDumpHardwareOutput

Add optional HardwareResourcesInformation printout to edmProvDump

Author: cmsbuild

IOPool/Common/bin/EdmProvDump.cc

@@ -54,10 +54,14 @@ namespace {
 
   class HistoryNode {
   public:
-    HistoryNode() : config_(), simpleId_(0) {}
+    HistoryNode() = default;
 
-    HistoryNode(edm::ProcessConfiguration const& iConfig, unsigned int iSimpleId)
-        : config_(iConfig), simpleId_(iSimpleId) {}
+    HistoryNode(edm::ProcessConfiguration const& iConfig,
+                unsigned int iSimpleId,
+                bool printHardwareResourcesDescription)
+        : config_(iConfig),
+          simpleId_(iSimpleId),
+          printHardwareResourcesDescription_(printHardwareResourcesDescription) {}
 
     void addChild(HistoryNode const& child) { children_.push_back(child); }
 
@@ -79,9 +83,21 @@ namespace {
     const_iterator end() const { return children_.end(); }
 
     void print(std::ostream& os) const {
-      // TODO: add printout of HardwareResourcesDescription
       os << config_.processName() << " '" << config_.releaseVersion() << "' [" << simpleId_ << "]  ("
-         << config_.parameterSetID() << ")" << std::endl;
+         << config_.parameterSetID() << ")";
+      if (printHardwareResourcesDescription_) {
+        auto const& hwresources = config_.hardwareResourcesDescription();
+        os << "  (" << hwresources.microarchitecture;
+        if (not hwresources.selectedAccelerators.empty()) {
+          os << "; " << hwresources.selectedAccelerators.front();
+          for (auto it = hwresources.selectedAccelerators.begin() + 1; it != hwresources.selectedAccelerators.end();
+               ++it) {
+            os << "," << *it;
+          }
+        }
+        os << ")";
+      }
+      os << std::endl;
     }
 
     void printHistory(std::string const& iIndent = std::string("  ")) const;
@@ -103,7 +119,8 @@ namespace {
   private:
     edm::ProcessConfiguration config_;
     std::vector<HistoryNode> children_;
-    unsigned int simpleId_;
+    unsigned int simpleId_ = 0;
+    bool printHardwareResourcesDescription_ = false;
   };
 
   std::ostream& operator<<(std::ostream& os, HistoryNode const& node) {
@@ -447,7 +464,8 @@ class ProvenanceDumper {
                    std::vector<std::string> const& findMatch,
                    bool dontPrintProducts,
                    std::string const& dumpPSetID,
-                   int productIDEntry);
+                   int productIDEntry,
+                   bool printHardwareResourcesDescription);
 
   ProvenanceDumper(ProvenanceDumper const&) = delete;             // Disallow copying and moving
   ProvenanceDumper& operator=(ProvenanceDumper const&) = delete;  // Disallow copying and moving
@@ -489,6 +507,7 @@ class ProvenanceDumper {
   bool dontPrintProducts_;
   std::string dumpPSetID_;
   int const productIDEntry_;
+  bool const printHardwareResourcesDescription_;
 
   void work_();
   void dumpProcessHistory_();
@@ -508,7 +527,8 @@ ProvenanceDumper::ProvenanceDumper(std::string const& filename,
                                    std::vector<std::string> const& findMatch,
                                    bool dontPrintProducts,
                                    std::string const& dumpPSetID,
-                                   int productIDEntry)
+                                   int productIDEntry,
+                                   bool printHardwareResourcesDescription)
     : filename_(filename),
       inputFile_(makeTFile(filename)),
       exitCode_(0),
@@ -524,7 +544,8 @@ ProvenanceDumper::ProvenanceDumper(std::string const& filename,
       findMatch_(findMatch),
       dontPrintProducts_(dontPrintProducts),
       dumpPSetID_(dumpPSetID),
-      productIDEntry_(productIDEntry) {}
+      productIDEntry_(productIDEntry),
+      printHardwareResourcesDescription_(printHardwareResourcesDescription) {}
 
 void ProvenanceDumper::dump() { work_(); }
 
@@ -614,7 +635,7 @@ void ProvenanceDumper::dumpProcessHistory_() {
           id = 1;
           simpleIDs[pc.id()] = id;
         }
-        parent->addChild(HistoryNode(pc, id));
+        parent->addChild(HistoryNode(pc, id, printHardwareResourcesDescription_));
         parent = parent->lastChildAddress();
       } else {
         //see if this is unique
@@ -628,7 +649,7 @@ void ProvenanceDumper::dumpProcessHistory_() {
         }
         if (isUnique) {
           simpleIDs[pc.id()] = parent->size() + 1;
-          parent->addChild(HistoryNode(pc, simpleIDs[pc.id()]));
+          parent->addChild(HistoryNode(pc, simpleIDs[pc.id()], printHardwareResourcesDescription_));
           parent = parent->lastChildAddress();
         }
       }
@@ -1131,6 +1152,7 @@ static char const* const kFileNameOpt = "input-file";
 static char const* const kDumpPSetIDOpt = "dumpPSetID";
 static char const* const kDumpPSetIDCommandOpt = "dumpPSetID,i";
 static char const* const kProductIDEntryOpt = "productIDEntry";
+static char const* const kHardwareOpt = "hardware";
 
 int main(int argc, char* argv[]) {
   using namespace boost::program_options;
@@ -1158,7 +1180,9 @@ int main(int argc, char* argv[]) {
       "print the parameter set associated with the parameter set ID string (and print nothing else)")(
       kProductIDEntryOpt,
       value<int>(),
-      "show ProductID instead of BranchID using the specified entry in the Events tree");
+      "show ProductID instead of BranchID using the specified entry in the Events tree")(
+      kHardwareOpt,
+      "include hardware provenance");
   // clang-format on
 
   //we don't want users to see these in the help messages since this
@@ -1270,6 +1294,11 @@ int main(int argc, char* argv[]) {
     }
   }
 
+  bool printHardwareResourcesDescription = false;
+  if (vm.count(kHardwareOpt)) {
+    printHardwareResourcesDescription = true;
+  }
+
   //silence ROOT warnings about missing dictionaries
   gErrorIgnoreLevel = kError;
 
@@ -1283,7 +1312,8 @@ int main(int argc, char* argv[]) {
                           findMatch,
                           dontPrintProducts,
                           dumpPSetID,
-                          productIDEntry);
+                          productIDEntry,
+                          printHardwareResourcesDescription);
   int exitCode(0);
   try {
     dumper.dump();

IOPool/Input/test/testReducedProcessHistoryHardwareResources.sh

@@ -12,15 +12,15 @@ function runSuccess {
 runSuccess ${SCRAM_TEST_PATH}/testReducedProcessHistoryCreate_cfg.py --accelerators test-one --firstEvent 1 --output test-one.root
 runSuccess ${SCRAM_TEST_PATH}/testReducedProcessHistoryCreate_cfg.py --accelerators test-two --firstEvent 101 --output test-two.root
 
-edmProvDump test-one.root | grep -q "PROD.*test-one" || die "Did not find test-one from test-one.root provenance" $?
-edmProvDump test-two.root | grep -q "PROD.*test-two" || die "Did not find test-two from test-two.root provenance" $?
+edmProvDump --hardware test-one.root | grep -q "PROD.*test-one" || die "Did not find test-one from test-one.root provenance" $?
+edmProvDump --hardware test-two.root | grep -q "PROD.*test-two" || die "Did not find test-two from test-two.root provenance" $?
 
 runSuccess ${SCRAM_TEST_PATH}/test_merge_two_files.py test-one.root test-two.root
 
 runSuccess ${SCRAM_TEST_PATH}/testReducedProcessHistory_cfg.py --input merged_files.root
 
-edmProvDump merged_files.root | grep -q "PROD.*test-one" || die "Did not find test-one from merged_files.root provenance" $?
-edmProvDump merged_files.root | grep -q "PROD.*test-two" || die "Did not find test-two from merged_files.root provenance" $?
+edmProvDump --hardware merged_files.root | grep -q "PROD.*test-one" || die "Did not find test-one from merged_files.root provenance" $?
+edmProvDump --hardware merged_files.root | grep -q "PROD.*test-two" || die "Did not find test-two from merged_files.root provenance" $?
 
 
 exit 0

IOPool/Streamer/test/run_TestReducedProcessHistoryHardwareResources.sh

@@ -15,7 +15,7 @@ CatStreamerFiles merged.dat test-one.dat test-two.dat
 
 runSuccess ${SCRAM_TEST_PATH}/testReducedProcessHistory_cfg.py --input merged.dat --output merged.root
 
-edmProvDump merged.root | grep -q "PROD.*test-one" || die "Did not find test-one from merged.root provenance" $?
-edmProvDump merged.root | grep -q "PROD.*test-two" || die "Did not find test-two from merged.root provenance" $?
+edmProvDump --hardware merged.root | grep -q "PROD.*test-one" || die "Did not find test-one from merged.root provenance" $?
+edmProvDump --hardware merged.root | grep -q "PROD.*test-two" || die "Did not find test-two from merged.root provenance" $?
 
 exit 0