ESProducerExternalWork.h

Go to the documentation of this file.

// -*- C++ -*-
#ifndef FWCore_Framework_ESProducerExternalWork_h
#define FWCore_Framework_ESProducerExternalWork_h
//
// Package:     Framework
// Class  :     ESProducerExternalWork
//
//
// Author:      W. David Dagenhart
// Created:     27 February 2023

#include <memory>
#include <string>
#include <type_traits>
#include <utility>
#include <vector>

#include "FWCore/Concurrency/interface/WaitingTaskWithArenaHolder.h"
#include "FWCore/Framework/interface/Callback.h"
#include "FWCore/Framework/interface/CallbackExternalWork.h"
#include "FWCore/Framework/interface/ESConsumesCollector.h"
#include "FWCore/Framework/interface/es_Label.h"
#include "FWCore/Framework/interface/ESProducer.h"
#include "FWCore/Framework/interface/produce_helpers.h"

namespace edm {

  class ESProducerExternalWork : public ESProducer {
  public:
    ESProducerExternalWork();

    // These replicate the setWhatProduced functions but add a second functor for
    // the acquire step. The acquire step is analogous to the acquire step for
    // EDProducers with the ExternalWork ability.

    template <typename T>
    auto setWhatAcquiredProduced(T* iThis, const es::Label& iLabel = {}) {
      return setWhatAcquiredProduced(iThis, &T::acquire, &T::produce, iLabel);
    }

    template <typename T>
    auto setWhatAcquiredProduced(T* iThis, const char* iLabel) {
      return setWhatAcquiredProduced(iThis, es::Label(iLabel));
    }
    template <typename T>
    auto setWhatAcquiredProduced(T* iThis, const std::string& iLabel) {
      return setWhatAcquiredProduced(iThis, es::Label(iLabel));
    }

    // Note the Decorator pre and post functions are only run before
    // and after the 'produce' function, but they are not run before
    // and after the 'acquire' function.

    template <typename T, typename TDecorator>
    auto setWhatAcquiredProduced(T* iThis, const TDecorator& iDec, const es::Label& iLabel = {}) {
      return setWhatAcquiredProduced(iThis, &T::acquire, &T::produce, iDec, iLabel);
    }

    template <typename T, typename TAcquireReturn, typename TProduceReturn, typename TRecord>
    auto setWhatAcquiredProduced(T* iThis,
                                 TAcquireReturn (T::*iAcquireMethod)(const TRecord&, WaitingTaskWithArenaHolder),
                                 TProduceReturn (T::*iProduceMethod)(const TRecord&, TAcquireReturn),
                                 const es::Label& iLabel = {}) {
      return setWhatAcquiredProduced(
          iThis, iAcquireMethod, iProduceMethod, eventsetup::CallbackSimpleDecorator<TRecord>(), iLabel);
    }

    template <typename T, typename TAcquireReturn, typename TProduceReturn, typename TRecord, typename TDecorator>
    auto setWhatAcquiredProduced(T* iThis,
                                 TAcquireReturn (T::*iAcquireMethod)(const TRecord&, WaitingTaskWithArenaHolder),
                                 TProduceReturn (T ::*iProduceMethod)(const TRecord&, TAcquireReturn),
                                 const TDecorator& iDec,
                                 const es::Label& iLabel = {}) {
      return setWhatAcquiredProducedWithLambda<TAcquireReturn, TProduceReturn, TRecord>(
          [iThis, iAcquireMethod](TRecord const& iRecord, WaitingTaskWithArenaHolder iHolder) {
            return (iThis->*iAcquireMethod)(iRecord, std::move(iHolder));
          },
          [iThis, iProduceMethod](TRecord const& iRecord, TAcquireReturn iAcquireReturn) {
            return (iThis->*iProduceMethod)(iRecord, std::move(iAcquireReturn));
          },
          createDecoratorFrom(iThis, static_cast<const TRecord*>(nullptr), iDec),
          iLabel);
    }

    template <typename TAcquireFunc, typename TProduceFunc>
    auto setWhatAcquiredProducedWithLambda(TAcquireFunc&& acquireFunc,
                                           TProduceFunc&& produceFunc,
                                           const es::Label& iLabel = {}) {
      using AcquireTypes = eventsetup::impl::ReturnArgumentTypes<TAcquireFunc>;
      using TRecord = typename AcquireTypes::argument_type;
      using TAcquireReturn = typename AcquireTypes::return_type;
      using TProduceReturn = std::invoke_result_t<TProduceFunc, TRecord const&, TAcquireReturn>;
      using DecoratorType = eventsetup::CallbackSimpleDecorator<TRecord>;

      return setWhatAcquiredProducedWithLambda<TAcquireReturn, TProduceReturn, TRecord>(
          std::forward<TAcquireFunc>(acquireFunc), std::forward<TProduceFunc>(produceFunc), DecoratorType(), iLabel);
    }

    // In this template, TReturn and TRecord cannot be deduced. They must be explicitly provided when called.
    // The previous 7 functions all end up calling this one (directly or indirectly).
    template <typename TAcquireReturn,
              typename TProduceReturn,
              typename TRecord,
              typename TAcquireFunc,
              typename TProduceFunc,
              typename TDecorator>
    ESConsumesCollectorT<TRecord> setWhatAcquiredProducedWithLambda(TAcquireFunc&& acquireFunc,
                                                                    TProduceFunc&& produceFunc,
                                                                    TDecorator&& iDec,
                                                                    const es::Label& iLabel = {}) {
      const auto id = consumesInfoSize();
      using DecoratorType = std::decay_t<TDecorator>;
      using CallbackType = eventsetup::CallbackExternalWork<ESProducerExternalWork,
                                                            TAcquireFunc,
                                                            TAcquireReturn,
                                                            TProduceFunc,
                                                            TProduceReturn,
                                                            TRecord,
                                                            DecoratorType>;
      unsigned int iovIndex = 0;  // Start with 0, but later will cycle through all of them
      auto temp = std::make_shared<CallbackType>(this,
                                                 std::forward<TAcquireFunc>(acquireFunc),
                                                 std::forward<TProduceFunc>(produceFunc),
                                                 id,
                                                 std::forward<TDecorator>(iDec));
      auto callback =
          std::make_shared<std::pair<unsigned int, std::shared_ptr<CallbackType>>>(iovIndex, std::move(temp));
      registerProducts(std::move(callback),
                       static_cast<const typename eventsetup::produce::product_traits<TProduceReturn>::type*>(nullptr),
                       static_cast<const TRecord*>(nullptr),
                       iLabel);
      return ESConsumesCollectorT<TRecord>(consumesInfoPushBackNew(), id);
    }
  };
}  // namespace edm
#endif