EventContentAnalyzer.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:    Modules
// Class:      EventContentAnalyzer
//
//
// Original Author:  Chris Jones
//         Created:  Mon Sep 19 11:47:28 CEST 2005
//
//

// user include files
#include "DataFormats/Provenance/interface/Provenance.h"
#include "FWCore/Framework/interface/one/EDAnalyzer.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/GenericHandle.h"
#include "FWCore/Framework/interface/MakerMacros.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
#include "FWCore/ParameterSet/interface/ParameterDescriptionNode.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
#include "FWCore/Utilities/interface/Algorithms.h"
#include "FWCore/Reflection/interface/FunctionWithDict.h"
#include "FWCore/Reflection/interface/MemberWithDict.h"
#include "FWCore/Reflection/interface/ObjectWithDict.h"
#include "FWCore/Reflection/interface/TypeWithDict.h"
#include "FWCore/Utilities/interface/TypeToGet.h"
#include "FWCore/ParameterSet/interface/Registry.h"

// system include files
#include <algorithm>
#include <iomanip>
#include <iostream>
#include <map>
#include <sstream>
#include <string>
#include <vector>

namespace edm {
  class ConfigurationDescriptions;
  namespace {
    std::string formatClassName(std::string const& iName) { return std::string("(") + iName + ")"; }

    char const* kNameValueSep = "=";
    template <typename T>
    void doPrint(std::string const& iName, ObjectWithDict const& iObject, std::string const& iIndent) {
      LogAbsolute("EventContent") << iIndent << iName << kNameValueSep
                                  << *reinterpret_cast<T*>(iObject.address());  // << "\n";
    }

    template <>
    void doPrint<char>(std::string const& iName, ObjectWithDict const& iObject, std::string const& iIndent) {
      LogAbsolute("EventContent") << iIndent << iName << kNameValueSep
                                  << static_cast<int>(*reinterpret_cast<char*>(iObject.address()));  // << "\n";
    }

    template <>
    void doPrint<unsigned char>(std::string const& iName, ObjectWithDict const& iObject, std::string const& iIndent) {
      LogAbsolute("EventContent") << iIndent << iName << kNameValueSep
                                  << static_cast<unsigned int>(
                                         *reinterpret_cast<unsigned char*>(iObject.address()));  // << "\n";
    }

    template <>
    void doPrint<bool>(std::string const& iName, ObjectWithDict const& iObject, std::string const& iIndent) {
      LogAbsolute("EventContent") << iIndent << iName << kNameValueSep
                                  << ((*reinterpret_cast<bool*>(iObject.address())) ? "true" : "false");  // << "\n";
    }

    typedef void (*FunctionType)(std::string const&, ObjectWithDict const&, std::string const&);
    typedef std::map<std::string, FunctionType> TypeToPrintMap;

    template <typename T>
    void addToMap(TypeToPrintMap& iMap) {
      iMap[typeid(T).name()] = doPrint<T>;
    }

    bool printAsBuiltin(std::string const& iName, ObjectWithDict const& iObject, std::string const& iIndent) {
      typedef void (*FunctionType)(std::string const&, ObjectWithDict const&, std::string const&);
      typedef std::map<std::string, FunctionType> TypeToPrintMap;
      static TypeToPrintMap s_map;
      static bool isFirst = true;
      if (isFirst) {
        addToMap<bool>(s_map);
        addToMap<char>(s_map);
        addToMap<short>(s_map);
        addToMap<int>(s_map);
        addToMap<long>(s_map);
        addToMap<unsigned char>(s_map);
        addToMap<unsigned short>(s_map);
        addToMap<unsigned int>(s_map);
        addToMap<unsigned long>(s_map);
        addToMap<float>(s_map);
        addToMap<double>(s_map);
        isFirst = false;
      }
      TypeToPrintMap::iterator itFound = s_map.find(iObject.typeOf().name());
      if (itFound == s_map.end()) {
        return false;
      }
      itFound->second(iName, iObject, iIndent);
      return true;
    }

    bool printAsContainer(std::string const& iName,
                          ObjectWithDict const& iObject,
                          std::string const& iIndent,
                          std::string const& iIndentDelta);

    void printObject(std::string const& iName,
                     ObjectWithDict const& iObject,
                     std::string const& iIndent,
                     std::string const& iIndentDelta) {
      const std::string& printName = iName;
      const ObjectWithDict& objectToPrint = iObject;
      std::string indent(iIndent);
      if (iObject.typeOf().isPointer()) {
        LogAbsolute("EventContent") << iIndent << iName << kNameValueSep << formatClassName(iObject.typeOf().name())
                                    << std::hex << iObject.address() << std::dec;  // << "\n";
        TypeWithDict pointedType = iObject.typeOf().toType();  // for Pointers, I get the real type this way
        if (TypeWithDict::byName("void") == pointedType || pointedType.isPointer() || iObject.address() == nullptr) {
          return;
        }
        return;
        /*
          //have the code that follows print the contents of the data to which the pointer points
          objectToPrint = ObjectWithDict(pointedType, iObject.address());
          //try to convert it to its actual type (assuming the original type was a base class)
          objectToPrint = ObjectWithDict(objectToPrint.castObject(objectToPrint.dynamicType()));
          printName = std::string("*")+iName;
          indent += iIndentDelta;
          */
      }
      std::string typeName(objectToPrint.typeOf().name());
      if (typeName.empty()) {
        typeName = "<unknown>";
      }

      if (printAsBuiltin(printName, objectToPrint, indent)) {
        return;
      }
      if (printAsContainer(printName, objectToPrint, indent, iIndentDelta)) {
        return;
      }

      LogAbsolute("EventContent") << indent << printName << " " << formatClassName(typeName);  // << "\n";
      indent += iIndentDelta;
      //print all the data members
      TypeDataMembers dataMembers(objectToPrint.typeOf());
      for (auto const& dataMember : dataMembers) {
        MemberWithDict const member(dataMember);
        //LogAbsolute("EventContent") << "     debug " << member.name() << " " << member.typeName() << "\n";
        try {
          printObject(member.name(), member.get(objectToPrint), indent, iIndentDelta);
        } catch (std::exception& iEx) {
          LogAbsolute("EventContent") << indent << member.name() << " <exception caught(" << iEx.what() << ")>\n";
        }
      }
    }

    bool printAsContainer(std::string const& iName,
                          ObjectWithDict const& iObject,
                          std::string const& iIndent,
                          std::string const& iIndentDelta) {
      ObjectWithDict sizeObj;
      try {
        size_t temp;  //used to hold the memory for the return value
        FunctionWithDict sizeFunc = iObject.typeOf().functionMemberByName("size");
        assert(sizeFunc.finalReturnType() == typeid(size_t));
        sizeObj = ObjectWithDict(TypeWithDict(typeid(size_t)), &temp);
        sizeFunc.invoke(iObject, &sizeObj);
        //std::cout << "size of type '" << sizeObj.name() << "' " << sizeObj.typeName() << std::endl;
        size_t size = *reinterpret_cast<size_t*>(sizeObj.address());
        FunctionWithDict atMember;
        try {
          atMember = iObject.typeOf().functionMemberByName("at");
        } catch (std::exception const& x) {
          //std::cerr << "could not get 'at' member because " << x.what() << std::endl;
          return false;
        }
        LogAbsolute("EventContent") << iIndent << iName << kNameValueSep << "[size=" << size << "]";  //"\n";
        ObjectWithDict contained;
        std::string indexIndent = iIndent + iIndentDelta;
        TypeWithDict atReturnType(atMember.finalReturnType());
        //std::cout << "return type " << atReturnType.name() << " size of " << atReturnType.SizeOf()
        // << " pointer? " << atReturnType.isPointer() << " ref? " << atReturnType.isReference() << std::endl;

        //Return by reference must be treated differently since reflex will not properly create
        // memory for a ref (which should just be a pointer to the object and not the object itself)
        //So we will create memory on the stack which can be used to hold a reference
        bool const isRef = atReturnType.isReference();
        void* refMemoryBuffer = nullptr;
        size_t index = 0;
        //The argument to the 'at' function is the index. Since the argument list holds pointers to the arguments
        // we only need to create it once and then when the value of index changes the pointer already
        // gets the new value
        std::vector<void*> args;
        args.push_back(&index);
        for (; index != size; ++index) {
          std::ostringstream sizeS;
          sizeS << "[" << index << "]";
          if (isRef) {
            ObjectWithDict refObject(atReturnType, &refMemoryBuffer);
            atMember.invoke(iObject, &refObject, args);
            //Although to hold the return value from a reference reflex requires you to pass it a
            // void** when it tries to call methods on the reference it expects to be given a void*
            contained = ObjectWithDict(atReturnType, refMemoryBuffer);
          } else {
            contained = atReturnType.construct();
            atMember.invoke(iObject, &contained, args);
          }
          //LogAbsolute("EventContent") << "invoked 'at'" << std::endl;
          try {
            printObject(sizeS.str(), contained, indexIndent, iIndentDelta);
          } catch (std::exception& iEx) {
            LogAbsolute("EventContent") << indexIndent << iName << " <exception caught(" << iEx.what() << ")>\n";
          }
          if (!isRef) {
            contained.destruct(true);
          }
        }
        return true;
      } catch (std::exception const& x) {
        //std::cerr << "failed to invoke 'at' because " << x.what() << std::endl;
        return false;
      }
      return false;
    }

    void printObject(Event const& iEvent,
                     std::string const& iClassName,
                     std::string const& iModuleLabel,
                     std::string const& iInstanceLabel,
                     std::string const& iProcessName,
                     std::string const& iIndent,
                     std::string const& iIndentDelta) {
      try {
        GenericHandle handle(iClassName);
      } catch (edm::Exception const&) {
        LogAbsolute("EventContent") << iIndent << " \"" << iClassName << "\""
                                    << " is an unknown type" << std::endl;
        return;
      }
      GenericHandle handle(iClassName);
      iEvent.getByLabel(InputTag(iModuleLabel, iInstanceLabel, iProcessName), handle);
      std::string className = formatClassName(iClassName);
      printObject(className, *handle, iIndent, iIndentDelta);
    }
  }  // namespace

  class EventContentAnalyzer : public one::EDAnalyzer<> {
  public:
    explicit EventContentAnalyzer(ParameterSet const&);
    ~EventContentAnalyzer() override;

    void analyze(Event const&, EventSetup const&) override;
    void endJob() override;

    static void fillDescriptions(ConfigurationDescriptions& descriptions);

  private:
    // ----------member data ---------------------------
    std::string indentation_;
    std::string verboseIndentation_;
    std::vector<std::string> moduleLabels_;
    bool verbose_;
    std::vector<std::string> getModuleLabels_;
    bool getData_;
    int evno_;
    std::map<std::string, int> cumulates_;
    bool listContent_;
    bool listProvenance_;
    bool listPathStatus_;
  };

  //
  // constructors and destructor
  //
  EventContentAnalyzer::EventContentAnalyzer(ParameterSet const& iConfig)
      : indentation_(iConfig.getUntrackedParameter<std::string>("indentation")),
        verboseIndentation_(iConfig.getUntrackedParameter<std::string>("verboseIndentation")),
        moduleLabels_(iConfig.getUntrackedParameter<std::vector<std::string>>("verboseForModuleLabels")),
        verbose_(iConfig.getUntrackedParameter<bool>("verbose") || !moduleLabels_.empty()),
        getModuleLabels_(iConfig.getUntrackedParameter<std::vector<std::string>>("getDataForModuleLabels")),
        getData_(iConfig.getUntrackedParameter<bool>("getData") || !getModuleLabels_.empty()),
        evno_(1),
        listContent_(iConfig.getUntrackedParameter<bool>("listContent")),
        listProvenance_(iConfig.getUntrackedParameter<bool>("listProvenance")),
        listPathStatus_(iConfig.getUntrackedParameter<bool>("listPathStatus")) {
    //now do what ever initialization is needed
    sort_all(moduleLabels_);
    sort_all(getModuleLabels_);
    if (getData_) {
      callWhenNewProductsRegistered([this](edm::BranchDescription const& iBranch) {
        if (getModuleLabels_.empty()) {
          const std::string kPathStatus("edm::PathStatus");
          const std::string kEndPathStatus("edm::EndPathStatus");
          if (iBranch.className() != kPathStatus && iBranch.className() != kEndPathStatus) {
            this->consumes(edm::TypeToGet{iBranch.unwrappedTypeID(), PRODUCT_TYPE},
                           edm::InputTag{iBranch.moduleLabel(), iBranch.productInstanceName(), iBranch.processName()});
          }
        } else {
          for (auto const& mod : this->getModuleLabels_) {
            if (iBranch.moduleLabel() == mod) {
              this->consumes(edm::TypeToGet{iBranch.unwrappedTypeID(), PRODUCT_TYPE},
                             edm::InputTag{mod, iBranch.productInstanceName(), iBranch.processName()});
              break;
            }
          }
        }
      });
    }
  }

  EventContentAnalyzer::~EventContentAnalyzer() {
    // do anything here that needs to be done at destruction time
    // (e.g. close files, deallocate resources etc.)
  }

  //
  // member functions
  //

  // ------------ method called to produce the data  ------------
  void EventContentAnalyzer::analyze(Event const& iEvent, EventSetup const&) {
    typedef std::vector<StableProvenance const*> Provenances;
    Provenances provenances;

    iEvent.getAllStableProvenance(provenances);

    if (listContent_) {
      LogAbsolute("EventContent") << "\n"
                                  << indentation_ << "Event " << std::setw(5) << evno_ << " contains "
                                  << provenances.size() << " product" << (provenances.size() == 1 ? "" : "s")
                                  << " with friendlyClassName, moduleLabel, productInstanceName and processName:"
                                  << std::endl;
    }

    std::string startIndent = indentation_ + verboseIndentation_;
    for (auto const& provenance : provenances) {
      std::string const& className = provenance->className();
      const std::string kPathStatus("edm::PathStatus");
      const std::string kEndPathStatus("edm::EndPathStatus");
      if (not listPathStatus_ and (className == kPathStatus || className == kEndPathStatus)) {
        continue;
      }
      std::string const& friendlyName = provenance->friendlyClassName();
      //if(friendlyName.empty())  friendlyName = std::string("||");

      std::string const& modLabel = provenance->moduleLabel();
      //if(modLabel.empty()) modLabel = std::string("||");

      std::string const& instanceName = provenance->productInstanceName();
      //if(instanceName.empty()) instanceName = std::string("||");

      std::string const& processName = provenance->processName();

      bool doVerbose = verbose_ && (moduleLabels_.empty() || binary_search_all(moduleLabels_, modLabel));

      if (listContent_ || doVerbose) {
        LogAbsolute("EventContent") << indentation_ << friendlyName << " \"" << modLabel << "\" \"" << instanceName
                                    << "\" \"" << processName << "\""
                                    << " (productId = " << provenance->productID() << ")" << std::endl;

        if (listProvenance_) {
          const bool isAlias = provenance->branchDescription().isAlias();
          std::string aliasForModLabel;
          LogAbsolute("EventContent") << *provenance;
          if (isAlias) {
            aliasForModLabel = iEvent.getStableProvenance(provenance->originalBranchID()).moduleLabel();
            LogAbsolute("EventContent") << "Is an alias for " << aliasForModLabel;
          }
          ProcessHistory const& processHistory = iEvent.processHistory();
          for (ProcessConfiguration const& pc : processHistory) {
            if (pc.processName() == provenance->processName()) {
              ParameterSetID const& psetID = pc.parameterSetID();
              pset::Registry const* psetRegistry = pset::Registry::instance();
              ParameterSet const* processPset = psetRegistry->getMapped(psetID);
              if (processPset) {
                if (processPset->existsAs<ParameterSet>(modLabel)) {
                  if (isAlias) {
                    LogAbsolute("EventContent") << "Alias PSet";
                  }
                  LogAbsolute("EventContent") << processPset->getParameterSet(modLabel);
                }
                if (isAlias and processPset->existsAs<ParameterSet>(aliasForModLabel)) {
                  LogAbsolute("EventContent") << processPset->getParameterSet(aliasForModLabel);
                }
              }
            }
          }
        }
      }
      std::string key = friendlyName + std::string(" + \"") + modLabel + std::string("\" + \"") + instanceName +
                        "\" \"" + processName + "\"";
      ++cumulates_[key];

      if (doVerbose) {
        //indent one level before starting to print
        printObject(iEvent, className, modLabel, instanceName, processName, startIndent, verboseIndentation_);
        continue;
      }
      if (getData_) {
        std::string class_and_label = friendlyName + "_" + modLabel;
        if (getModuleLabels_.empty() || binary_search_all(getModuleLabels_, modLabel) ||
            binary_search_all(getModuleLabels_, class_and_label)) {
          try {
            GenericHandle handle(className);
          } catch (edm::Exception const&) {
            LogAbsolute("EventContent") << startIndent << " \"" << className << "\""
                                        << " is an unknown type" << std::endl;
            return;
          }
          GenericHandle handle(className);
          iEvent.getByLabel(InputTag(modLabel, instanceName, processName), handle);
        }
      }
    }
    //std::cout << "Mine" << std::endl;
    ++evno_;
  }

  // ------------ method called at end of job -------------------
  void EventContentAnalyzer::endJob() {
    typedef std::map<std::string, int> nameMap;

    LogAbsolute("EventContent") << "\nSummary for key being the concatenation of friendlyClassName, moduleLabel, "
                                   "productInstanceName and processName"
                                << std::endl;
    for (nameMap::const_iterator it = cumulates_.begin(), itEnd = cumulates_.end(); it != itEnd; ++it) {
      LogAbsolute("EventContent") << std::setw(6) << it->second << " occurrences of key " << it->first << std::endl;
    }
  }

  void EventContentAnalyzer::fillDescriptions(ConfigurationDescriptions& descriptions) {
    descriptions.setComment(
        "This plugin will print a list of all products in the event "
        "provenance.  It also has options to print and/or get each product.");

    ParameterSetDescription desc;

    ParameterDescriptionNode* np;

    std::string defaultString("++");
    np = desc.addUntracked<std::string>("indentation", defaultString);
    np->setComment("This string is printed at the beginning of every line printed during event processing.");

    np = desc.addUntracked<bool>("verbose", false);
    np->setComment("If true, the contents of products are printed.");

    defaultString = "  ";
    np = desc.addUntracked<std::string>("verboseIndentation", defaultString);
    np->setComment(
        "This string is used to further indent lines when printing the contents of products in verbose mode.");

    std::vector<std::string> defaultVString;

    np = desc.addUntracked<std::vector<std::string>>("verboseForModuleLabels", defaultVString);
    np->setComment("If this vector is not empty, then only products with module labels on this list are printed.");

    np = desc.addUntracked<bool>("getData", false);
    np->setComment("If true the products will be retrieved using getByLabel.");

    np = desc.addUntracked<std::vector<std::string>>("getDataForModuleLabels", defaultVString);
    np->setComment(
        "If this vector is not empty, then only products with module labels on this list are retrieved by getByLabel.");

    np = desc.addUntracked<bool>("listContent", true);
    np->setComment("If true then print a list of all the event content.");

    np = desc.addUntracked<bool>("listProvenance", false);
    np->setComment("If true, and if listContent or verbose is true, print provenance information for each product");

    desc.addUntracked<bool>("listPathStatus", false)
        ->setComment("If true, also show PathStatus/EndPathStatus data products.");
    descriptions.add("printContent", desc);
    descriptions.addDefault(desc);
  }
}  // namespace edm

using edm::EventContentAnalyzer;
DEFINE_FWK_MODULE(EventContentAnalyzer);