DaqProvenanceHelper.cc

Go to the documentation of this file.

#include <algorithm>
#include <cassert>
#include <vector>

#include "FWCore/Sources/interface/DaqProvenanceHelper.h"

#include "DataFormats/Provenance/interface/BranchChildren.h"
#include "DataFormats/Provenance/interface/BranchIDList.h"
#include "DataFormats/Provenance/interface/ProcessHistory.h"
#include "DataFormats/Provenance/interface/ProcessHistoryRegistry.h"
#include "DataFormats/Provenance/interface/ProductRegistry.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/Utilities/interface/EDMException.h"
#include "FWCore/Utilities/interface/GetPassID.h"
#include "FWCore/Reflection/interface/TypeWithDict.h"
#include "FWCore/Version/interface/GetReleaseVersion.h"

namespace {
  edm::BranchDescription makeDescriptionForDaqProvHelper(edm::TypeID const& rawDataType,
                                                         std::string const& collectionName,
                                                         std::string const& friendlyName,
                                                         std::string const& sourceLabel) {
    edm::BranchDescription desc(edm::InEvent,
                                "rawDataCollector",
                                // "source",
                                "LHC",
                                // "HLT",
                                collectionName,
                                friendlyName,
                                "",
                                sourceLabel,
                                edm::ParameterSetID(),
                                edm::TypeWithDict(rawDataType.typeInfo()),
                                false);
    desc.setIsProvenanceSetOnRead();
    return desc;
  }
}  // namespace

namespace edm {
  DaqProvenanceHelper::DaqProvenanceHelper(TypeID const& rawDataType,
                                           std::string const& collectionName,
                                           std::string const& friendlyName,
                                           std::string const& sourceLabel)
      : constBranchDescription_(
            makeDescriptionForDaqProvHelper(rawDataType, collectionName, friendlyName, sourceLabel)),
        dummyProvenance_(constBranchDescription_.branchID()),
        processParameterSet_(),
        oldProcessName_(),
        oldBranchID_(),
        newBranchID_(),
        oldProcessHistoryID_(nullptr),
        phidMap_() {
    // Now we create a process parameter set for the "LHC" process.
    // We don't currently use the untracked parameters, However, we make them available, just in case.
    std::string const& moduleLabel = constBranchDescription_.moduleLabel();
    std::string const& processName = constBranchDescription_.processName();
    std::string const& moduleName = constBranchDescription_.moduleName();
    typedef std::vector<std::string> vstring;
    vstring empty;

    vstring modlbl;
    modlbl.reserve(1);
    modlbl.push_back(moduleLabel);
    processParameterSet_.addParameter("@all_sources", modlbl);

    ParameterSet triggerPaths;
    triggerPaths.addParameter<vstring>("@trigger_paths", empty);
    processParameterSet_.addParameter<ParameterSet>("@trigger_paths", triggerPaths);

    ParameterSet pseudoInput;
    pseudoInput.addParameter<std::string>("@module_edm_type", "Source");
    pseudoInput.addParameter<std::string>("@module_label", moduleLabel);
    pseudoInput.addParameter<std::string>("@module_type", moduleName);
    processParameterSet_.addParameter<ParameterSet>(moduleLabel, pseudoInput);

    processParameterSet_.addParameter<vstring>("@all_esmodules", empty);
    processParameterSet_.addParameter<vstring>("@all_esprefers", empty);
    processParameterSet_.addParameter<vstring>("@all_essources", empty);
    processParameterSet_.addParameter<vstring>("@all_loopers", empty);
    processParameterSet_.addParameter<vstring>("@all_modules", empty);
    processParameterSet_.addParameter<vstring>("@end_paths", empty);
    processParameterSet_.addParameter<vstring>("@paths", empty);
    processParameterSet_.addParameter<std::string>("@process_name", processName);
    // Now we register the process parameter set.
    processParameterSet_.registerIt();

    //std::cerr << processParameterSet_.dump() << std::endl;
  }

  //default
  DaqProvenanceHelper::DaqProvenanceHelper(TypeID const& rawDataType)
      : DaqProvenanceHelper(rawDataType, "FEDRawDataCollection", "FEDRawDataCollection", "FedRawDataInputSource") {}

  ProcessHistoryID DaqProvenanceHelper::daqInit(ProductRegistry& productRegistry,
                                                ProcessHistoryRegistry& processHistoryRegistry) const {
    // Now we need to set all the metadata
    // Add the product to the product registry
    productRegistry.copyProduct(constBranchDescription_);

    // Insert an entry for this process in the process history registry
    ProcessHistory ph;
    ph.emplace_back(constBranchDescription_.processName(), processParameterSet_.id(), getReleaseVersion(), getPassID());
    processHistoryRegistry.registerProcessHistory(ph);

    // Save the process history ID for use every event.
    return ph.setProcessHistoryID();
  }

  bool DaqProvenanceHelper::matchProcesses(ProcessConfiguration const& newPC, ProcessHistory const& ph) const {
    for (auto const& pc : ph) {
      if (pc.processName() == oldProcessName_) {
        return (pc.releaseVersion() == newPC.releaseVersion() && pc.passID() == newPC.passID());
      }
    }
    return false;
  }

  void DaqProvenanceHelper::fixMetaData(std::vector<ProcessConfiguration>& pcv, std::vector<ProcessHistory>& phv) {
    phv.push_back(ProcessHistory());  // For new processHistory, containing only processConfiguration_
    std::vector<ProcessConfiguration> newPCs;
    for (auto const& pc : pcv) {
      if (pc.processName() == oldProcessName_) {
        newPCs.emplace_back(
            constBranchDescription_.processName(), processParameterSet_.id(), pc.releaseVersion(), pc.passID());
      }
    }
    if (newPCs.empty()) {
      throw Exception(errors::LogicError) << "\nFatal error in RootFile constructor. Most likely this is because\n"
                                          << "the input file contains a FEDRawDataCollection with module label\n"
                                          << "\"source\". This is against CMS naming conventions.\n"
                                          << "See GitHub Issue 45137 for related details.\n";
    }
    pcv.reserve(pcv.size() + newPCs.size());
    pcv.insert(pcv.end(), newPCs.begin(), newPCs.end());
    // update existing process histories
    for (auto& ph : phv) {
      for (auto const& newPC : newPCs) {
        if (ph.empty() || matchProcesses(newPC, ph)) {
          ProcessHistoryID oldPHID = ph.id();
          ph.push_front(newPC);
          ProcessHistoryID newPHID = ph.id();
          phidMap_.insert(std::make_pair(oldPHID, newPHID));
          break;
        }
      }
    }
    // For new process histories, containing only the new process configurations
    phv.reserve(phv.size() + newPCs.size());
    for (auto const& newPC : newPCs) {
      phv.emplace_back();
      phv.back().push_front(newPC);
    }
  }

  void DaqProvenanceHelper::fixMetaData(std::vector<BranchID>& branchID) const {
    std::replace(branchID.begin(), branchID.end(), oldBranchID_, newBranchID_);
  }

  void DaqProvenanceHelper::fixMetaData(BranchIDLists const& branchIDLists) const {
    BranchID::value_type oldID = oldBranchID_.id();
    BranchID::value_type newID = newBranchID_.id();
    // The const_cast is ugly, but it beats the alternatives.
    BranchIDLists& lists = const_cast<BranchIDLists&>(branchIDLists);
    for (auto& list : lists) {
      std::replace(list.begin(), list.end(), oldID, newID);
    }
  }

  void DaqProvenanceHelper::fixMetaData(BranchChildren& branchChildren) const {
    typedef std::map<BranchID, std::set<BranchID> > BCMap;
    // The const_cast is ugly, but it beats the alternatives.
    BCMap& childLookup = const_cast<BCMap&>(branchChildren.childLookup());
    // First fix any old branchID's in the key.
    {
      BCMap::iterator i = childLookup.find(oldBranchID_);
      if (i != childLookup.end()) {
        childLookup.insert(std::make_pair(newBranchID_, i->second));
        childLookup.erase(i);
      }
    }
    // Now fix any old branchID's in the sets;
    for (auto& child : childLookup) {
      if (child.second.erase(oldBranchID_) != 0) {
        child.second.insert(newBranchID_);
      }
    }
  }

  // Replace process history ID.
  ProcessHistoryID const& DaqProvenanceHelper::mapProcessHistoryID(ProcessHistoryID const& phid) {
    ProcessHistoryIDMap::const_iterator it = phidMap_.find(phid);
    assert(it != phidMap_.end());
    oldProcessHistoryID_ = &it->first;
    return it->second;
  }

  // Replace parentage ID.
  ParentageID const& DaqProvenanceHelper::mapParentageID(ParentageID const& parentageID) const {
    ParentageIDMap::const_iterator it = parentageIDMap_.find(parentageID);
    if (it == parentageIDMap_.end()) {
      return parentageID;
    }
    return it->second;
  }

  // Replace branch ID if necessary.
  BranchID const& DaqProvenanceHelper::mapBranchID(BranchID const& branchID) const {
    return (branchID == oldBranchID_ ? newBranchID_ : branchID);
  }

  void DaqProvenanceHelper::setOldParentageIDToNew(ParentageID const& iOld, ParentageID const& iNew) {
    parentageIDMap_.insert(std::make_pair(iOld, iNew));
  }

}  // namespace edm