VectorAddOCLExampleAlg.h

Go to the documentation of this file.

//
// Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
//
#ifndef ATHEXXRT_VECTORADDOCLEXAMPLEALG_H
#define ATHEXXRT_VECTORADDOCLEXAMPLEALG_H
 
// STL include(s).
#include <memory>
 
// AthXRT include(s).
#include "AthXRTInterfaces/IDeviceMgmtSvc.h"
#include "AthXRTInterfaces/StateHandler.h"
 
// Framework include(s).
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "AthenaKernel/SlotSpecificObj.h"
#include "GaudiKernel/ServiceHandle.h"
 
namespace AthExXRT {

class VectorAddOCLExampleAlg : public ::AthReentrantAlgorithm, public AthXRT::StateHandler {
 
 public:
  // Inherit the base class's constructor(s).
  using ::AthReentrantAlgorithm::AthReentrantAlgorithm;
 
  virtual StatusCode initialize() override {
      return StateHandler::initialize();
  }
 
  virtual StatusCode initialize_global() override;
  virtual StatusCode initialize_worker() override;
 
  virtual StatusCode execute(const EventContext& ctx) const override;
 
  virtual StatusCode stop() override {
      return StateHandler::stop();
  }
  virtual StatusCode stop_worker() override;
 
 private:

  ServiceHandle<AthXRT::IDeviceMgmtSvc> m_DeviceMgmtSvc{
      this, "DeviceMgmtSvc", "AthXRT::DeviceMgmtSvc",
      "The XRT device manager service to use"};
 
  // Kernel name string
  static constexpr char s_krnl_name[] = "krnl_VectorAdd";
 
  // Kernel arguments indexes
  // Must match the kernel arguments order.
  static constexpr int s_krnl_param_in1 = 0;
  static constexpr int s_krnl_param_in2 = 1;
  static constexpr int s_krnl_param_out = 2;
  static constexpr int s_krnl_param_size = 3;
 
  // Number of uint32_t element in the vectors
  static constexpr int s_element_count = 4096;
 
  std::vector<AthXRT::IDeviceMgmtSvc::OpenCLHandle> m_handles;

  struct SlotData {
    std::shared_ptr<cl::Context> m_context = nullptr;

    std::shared_ptr<cl::Program> m_program = nullptr;

    std::unique_ptr<cl::Kernel> m_kernel = nullptr;

    std::unique_ptr<cl::CommandQueue> m_queue = nullptr;

    std::unique_ptr<cl::Buffer> m_dev_buf_in1 = nullptr;
    std::unique_ptr<cl::Buffer> m_dev_buf_in2 = nullptr;
    std::unique_ptr<cl::Buffer> m_dev_buf_out = nullptr;
 
    uint32_t* m_host_buf_in1 = nullptr;
    uint32_t* m_host_buf_in2 = nullptr;
    uint32_t* m_host_buf_out = nullptr;
  };

  SG::SlotSpecificObj<SlotData> m_slots;
 
};  // class VectorAddOCLExampleAlg
 
}  // namespace AthExXRT
 
#endif  // ATHEXXRT_VECTORADDOCLEXAMPLEALG_H