DataHolders.h

Go to the documentation of this file.

//
// Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
//
// Dear emacs, this is -*- c++ -*-
//
 
#ifndef CALORECGPU_DATAHOLDERS_H
#define CALORECGPU_DATAHOLDERS_H
 
#include <vector>
 
#include "Helpers.h"
#include "CUDAFriendlyClasses.h"
 
#define CALORECGPU_USE_PINNED_MEMORY 1
 
namespace CaloRecGPU
{

  class ConstantDataHolder
  {
   public:
 
    void sendToGPU(const bool clear_CPU = true);
 
    CaloRecGPU::Helpers::CPU_object<CaloRecGPU::GeometryArr> m_geometry;
 
    CaloRecGPU::Helpers::CPU_object<CaloRecGPU::CellNoiseArr> m_cell_noise;
 
    CaloRecGPU::Helpers::CUDA_object<CaloRecGPU::GeometryArr> m_geometry_dev;
 
    CaloRecGPU::Helpers::CUDA_object<CaloRecGPU::CellNoiseArr> m_cell_noise_dev;
 
  };

  struct MomentsOptionsArray
  {
    static constexpr int num_moments = 72;
    bool array[num_moments + 1]{};
    //Initialize to false.
    //(We could consider using
    //some form of bitset here,
    //but I'm not sure there would be
    //a significant performance difference...)
 
    static int moment_to_linear(const int moment);
 
    bool & operator[] (const int moment);
 
    bool operator[] (const int  moment) const;
    
    static MomentsOptionsArray all();
  };

  class EventDataHolder
  {
   public:
   
    void importCells(const void * cell_collection, const std::vector<int> & extra_cells_to_fill = {});

    void importClusters(const void * cluster_collection, 
                        const MomentsOptionsArray & moments_to_add,
                        const bool output_tags = true,
                        const bool consider_shared_cells = true,
                        const bool output_moments = false,
                        const bool output_extra_moments = false,
                        const std::vector<int> & extra_cells_to_fill = {});

    void sendToGPU(const MomentsOptionsArray & moments_to_add,
                   const bool full_copy = false,
                   const bool clear_CPU = false,
                   const bool synchronize = false,
                   CaloRecGPU::CUDA_Helpers::CUDAStreamPtrHolder stream = {});

    void returnToCPU(const MomentsOptionsArray & moments_to_add,
                     const bool full_copy = false,
                     const bool clear_GPU = false,
                     const bool synchronize = false,
                     CaloRecGPU::CUDA_Helpers::CUDAStreamPtrHolder stream = {},
                     const bool also_return_cells = false);
    
    void exportClusters(void * cluster_collection,
                        const void * cell_collection_link,
                        const MomentsOptionsArray & moments_to_add,
                        const bool sort_clusters = true,
                        const bool save_uncalibrated = true,
                        const bool output_extra_moments = false,
                        const std::vector<int> & extra_cells_to_fill = {},
                        size_t * time_measurements = nullptr);
    
    void returnAndExportClusters(void * cluster_collection,
                                 const void * cell_collection_link,
                                 const MomentsOptionsArray & moments_to_add,
                                 const bool sort_clusters = true,
                                 const bool save_uncalibrated = true,
                                 const bool output_extra_moments = false,
                                 const std::vector<int> & extra_cells_to_fill = {},
                                 size_t * time_measurements = nullptr,
                                 CaloRecGPU::CUDA_Helpers::CUDAStreamPtrHolder stream = {});
    
    void allocate(const bool also_GPU = true);
    
    void clear_GPU();
 
#if CALORECGPU_USE_PINNED_MEMORY
 
    CaloRecGPU::Helpers::CUDA_pinned_CPU_object<CaloRecGPU::CellInfoArr> m_cell_info;
    CaloRecGPU::Helpers::CUDA_pinned_CPU_object<CaloRecGPU::ClusterInfoArr> m_clusters;
 
#else
 
    CaloRecGPU::Helpers::CPU_object<CaloRecGPU::CellInfoArr> m_cell_info;
    CaloRecGPU::Helpers::CPU_object<CaloRecGPU::ClusterInfoArr> m_clusters;
 
#endif
 
    CaloRecGPU::Helpers::CUDA_object<CaloRecGPU::CellInfoArr> m_cell_info_dev;
    CaloRecGPU::Helpers::CUDA_object<CaloRecGPU::ClusterInfoArr> m_clusters_dev;
 
  };
 
}
 
#endif //CALORECGPU_DATAHOLDERS_H