FWCore/TestModules/plugins/SecondaryProducer.cc - master - githubmirror/cmssw

FWCore/TestModules/plugins/SecondaryProducer.cc
210 строк9 KB
Chris Jones
Removed support for thinning
09 мар 2026, 22:07
09 мар 2026, 22:072bcf291
// File: SecondaryProducer.cc
// Description:  see SecondaryProducer.h
// Author:  Bill Tanenbaum
//
//--------------------------------------------

#include "DataFormats/Common/interface/ConvertHandle.h"
#include "DataFormats/Common/interface/Handle.h"
#include "DataFormats/Provenance/interface/BranchIDListHelper.h"
#include "DataFormats/Provenance/interface/EventID.h"
#include "DataFormats/Provenance/interface/LuminosityBlockID.h"
#include "DataFormats/Provenance/interface/ProcessConfiguration.h"
#include "DataFormats/TestObjects/interface/OtherThingCollection.h"
#include "DataFormats/TestObjects/interface/ThingCollection.h"
#include "DataFormats/TestObjects/interface/ToyProducts.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/EventPrincipal.h"
#include "FWCore/Framework/interface/MakerMacros.h"
#include "FWCore/Framework/interface/ProductResolversFactory.h"
#include "FWCore/Framework/interface/one/EDProducer.h"
#include "DataFormats/Provenance/interface/BranchIDListHelper.h"
#include "DataFormats/Provenance/interface/ModuleDescription.h"
#include "FWCore/Framework/interface/SignallingProductRegistryFiller.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/ServiceRegistry/interface/ActivityRegistry.h"
#include "FWCore/ServiceRegistry/interface/Service.h"
#include "FWCore/Sources/interface/VectorInputSource.h"
#include "FWCore/Sources/interface/VectorInputSourceDescription.h"
#include "FWCore/Sources/interface/VectorInputSourceFactory.h"
#include "FWCore/Utilities/interface/ProductKindOfType.h"
#include "FWCore/Utilities/interface/TypeID.h"
#include "FWCore/Utilities/interface/get_underlying_safe.h"
#include "FWCore/Version/interface/GetReleaseVersion.h"

#include "FWCore/AbstractServices/interface/RandomNumberGenerator.h"
#include "FWCore/ServiceRegistry/interface/Service.h"
#include "FWCore/Utilities/interface/Exception.h"

#include <memory>
#include <string>

namespace CLHEP {
  class HepRandomEngine;
}

namespace edm {
  class SecondaryProducer : public one::EDProducer<> {
  public:
    /** standard constructor*/
    explicit SecondaryProducer(ParameterSet const& pset);

    /**Default destructor*/
    ~SecondaryProducer() override;

    /**Accumulates the pileup events into this event*/
    void produce(Event& e1, EventSetup const& c) override;

    bool processOneEvent(EventPrincipal const& eventPrincipal, Event& e);

  private:
    virtual void put(Event&) {}
    void beginJob() override;
    void endJob() override;
    std::shared_ptr<VectorInputSource> makeSecInput(ParameterSet const& ps);

    std::shared_ptr<ProductRegistry const> productRegistry() const { return get_underlying_safe(productRegistry_); }
    std::shared_ptr<ProductRegistry>& productRegistry() { return get_underlying_safe(productRegistry_); }

    edm::propagate_const<std::shared_ptr<ProductRegistry>> productRegistry_;
    edm::propagate_const<std::shared_ptr<VectorInputSource>> secInput_;
    edm::propagate_const<std::unique_ptr<ProcessConfiguration>> processConfiguration_;
    edm::propagate_const<std::unique_ptr<EventPrincipal>> eventPrincipal_;
    bool sequential_;
    bool specified_;
    bool sameLumiBlock_;
    bool firstEvent_;
    bool firstLoop_;
    EventNumber_t expectedEventNumber_;
  };

  // Constructor
  // make secondary input source
  SecondaryProducer::SecondaryProducer(ParameterSet const& pset)
      : productRegistry_(std::make_shared<ProductRegistry>()),
        secInput_(makeSecInput(pset)),
        processConfiguration_(std::make_unique<ProcessConfiguration>(
            std::string("PROD"), getReleaseVersion(), HardwareResourcesDescription())),
        eventPrincipal_(),
        sequential_(pset.getUntrackedParameter<bool>("seq", false)),
        specified_(pset.getUntrackedParameter<bool>("specified", false)),
        firstEvent_(true),
        firstLoop_(true),
        expectedEventNumber_(
            sequential_ ? pset.getParameterSet("input").getUntrackedParameter<unsigned int>("skipEvents", 0) + 1 : 1) {
    processConfiguration_->setParameterSetID(ParameterSet::emptyParameterSetID());
    processConfiguration_->setProcessConfigurationID();

    productRegistry_->setFrozen();

    produces<edmtest::ThingCollection>();
    produces<edmtest::OtherThingCollection>("testUserTag");
    consumes<edmtest::UInt64Product>(edm::InputTag{"EventNumber"});
  }

  void SecondaryProducer::beginJob() {
    // propagate_const<T> has no reset() function
    eventPrincipal_ = std::make_unique<EventPrincipal>(secInput_->productRegistry(),
                                                       edm::productResolversFactory::makePrimary,
                                                       std::make_shared<BranchIDListHelper>(),
                                                       *processConfiguration_,
                                                       nullptr);
  }

  // Virtual destructor needed.
  SecondaryProducer::~SecondaryProducer() {}

  // Functions that get called by framework every event
  void SecondaryProducer::produce(Event& e, EventSetup const&) {
    using std::placeholders::_1;
    size_t fileNameHash = 0U;

    if (specified_) {
      // Just for simplicity, we use the event ID from the primary to read the secondary.
      std::vector<SecondaryEventIDAndFileInfo> events(1, SecondaryEventIDAndFileInfo(e.id(), fileNameHash));
      secInput_->loopSpecified(*eventPrincipal_,
                               fileNameHash,
                               events.begin(),
                               events.end(),
                               std::bind(&SecondaryProducer::processOneEvent, this, _1, std::ref(e)));
    } else {
      CLHEP::HepRandomEngine* engine = nullptr;
      if (!sequential_) {
        edm::Service<edm::RandomNumberGenerator> rng;
        if (!rng.isAvailable()) {
          throw cms::Exception("Configuration")
              << "SecondaryProducer requires the RandomNumberGeneratorService,\n"
                 "which is not present in the configuration file.  You must add the service\n"
                 "in the configuration file or remove the modules that require it.";
        }
        engine = &rng->getEngine(e.streamID());
      }
      // Just for simplicity, we use the event ID from the primary to read the secondary.
      EventID id = e.id();
      secInput_->loopOverEvents(*eventPrincipal_,
                                fileNameHash,
                                1,
                                std::bind(&SecondaryProducer::processOneEvent, this, _1, std::ref(e)),
                                engine,
                                &id);
    }
  }

  bool SecondaryProducer::processOneEvent(EventPrincipal const& eventPrincipal, Event& e) {
    typedef edmtest::ThingCollection TC;
    typedef Wrapper<TC> WTC;

    EventNumber_t en = eventPrincipal.id().event();
    // Check that secondary source products are retrieved from the same event as the EventAuxiliary
    BasicHandle bhandle = eventPrincipal.getByLabel(
        PRODUCT_TYPE, TypeID(typeid(edmtest::UInt64Product)), "EventNumber", "", "", nullptr, nullptr, nullptr);
    assert(bhandle.isValid());
    Handle<edmtest::UInt64Product> handle = convert_handle<edmtest::UInt64Product>(std::move(bhandle));
    assert(static_cast<EventNumber_t>(handle->value) == en);

    // Check that primary source products are retrieved from the same event as the EventAuxiliary
    e.getByLabel<edmtest::UInt64Product>("EventNumber", handle);
    assert(static_cast<EventNumber_t>(handle->value) == e.id().event());

    WrapperBase const* ep =
        eventPrincipal.getByLabel(PRODUCT_TYPE, TypeID(typeid(TC)), "Thing", "", "", nullptr, nullptr, nullptr)
            .wrapper();
    assert(ep != nullptr);
    WTC const* wtp = static_cast<WTC const*>(ep);
    assert(wtp);
    TC const* tp = wtp->product();
    auto thing = std::make_unique<TC>(*tp);

    // Put output into event
    e.put(std::move(thing));

    if (!sequential_ && !specified_ && firstLoop_ && en == 1) {
      expectedEventNumber_ = 1;
      firstLoop_ = false;
    }
    if (firstEvent_) {
      firstEvent_ = false;
      if (!sequential_ && !specified_) {
        expectedEventNumber_ = en;
      }
    }
    assert(expectedEventNumber_ == en);
    ++expectedEventNumber_;

    return true;
  }

  std::shared_ptr<VectorInputSource> SecondaryProducer::makeSecInput(ParameterSet const& ps) {
    ParameterSet const& sec_input = ps.getParameterSet("input");
    PreallocationConfiguration dummy;
    VectorInputSourceDescription desc(productRegistry(), dummy);
    std::shared_ptr<VectorInputSource> input_(static_cast<VectorInputSource*>(
        VectorInputSourceFactory::get()->makeVectorInputSource(sec_input, desc).release()));
    return input_;
  }

  void SecondaryProducer::endJob() { secInput_->doEndJob(); }

}  // namespace edm
using edm::SecondaryProducer;
DEFINE_FWK_MODULE(SecondaryProducer);