DeviceProduct.h

Go to the documentation of this file.

#ifndef DataFormats_Common_interface_DeviceProduct_h
#define DataFormats_Common_interface_DeviceProduct_h

#include <cassert>
#include <memory>

namespace edm {
  class DeviceProductBase {
  public:
    DeviceProductBase() = default;
    ~DeviceProductBase() = default;

    // TODO: in principle this function is an implementation detail
    template <typename M>
    M const& metadata() const {
      // TODO: I believe the assertion could be removed safely after
      // the data dependence and scheduling systems would guarantee
      // that the an EDModule in a given execution space can access
      // only to the EDProducts in a memory space compatible with the
      // execution space.
      //
      // On the other hand, with Alpaka (likely with others) the
      // getSynchronized() does additional checks so the added cost is
      // probably not that much?
      assert(typeid(M) == *metadataType_);
      return *static_cast<M const*>(metadata_.get());
    }

  protected:
    template <typename M>
    explicit DeviceProductBase(std::shared_ptr<M> metadata)
        : metadata_(std::move(metadata)), metadataType_(&typeid(M)) {}

  private:
    std::shared_ptr<void const> metadata_;
    std::type_info const* metadataType_;
  };

  template <typename T>
  class DeviceProduct : public DeviceProductBase {
  public:
    DeviceProduct() = default;

    template <typename M, typename... Args>
    explicit DeviceProduct(std::shared_ptr<M> metadata, Args&&... args)
        : DeviceProductBase(std::move(metadata)), data_(std::forward<Args>(args)...) {}

    DeviceProduct(const DeviceProduct&) = delete;
    DeviceProduct& operator=(const DeviceProduct&) = delete;
    DeviceProduct(DeviceProduct&&) = default;
    DeviceProduct& operator=(DeviceProduct&&) = default;

    template <typename M, typename... Args>
    T const& getSynchronized(Args&&... args) const {
      auto const& md = metadata<M>();
      md.synchronize(std::forward<Args>(args)...);
      return data_;
    }

  private:
    T data_;  
  };
}  // namespace edm
#endif