Back to home page

Project CMSSW displayed by LXR

 
 

    


File indexing completed on 2025-02-05 03:15:15

0001 #include <memory>
0002 #include <optional>
0003 #include <stdexcept>
0004 #include <string>
0005 #include <utility>
0006 #include <vector>
0007 
0008 #include "CalibTracker/Records/interface/SiPixelGainCalibrationForHLTSoARcd.h"
0009 #include "CalibTracker/Records/interface/SiPixelMappingSoARecord.h"
0010 #include "CondFormats/DataRecord/interface/SiPixelFedCablingMapRcd.h"
0011 #include "CondFormats/SiPixelObjects/interface/SiPixelFedCablingMap.h"
0012 #include "CondFormats/SiPixelObjects/interface/SiPixelFedCablingTree.h"
0013 #include "CondFormats/SiPixelObjects/interface/alpaka/SiPixelGainCalibrationForHLTDevice.h"
0014 #include "CondFormats/SiPixelObjects/interface/alpaka/SiPixelMappingDevice.h"
0015 #include "CondFormats/SiPixelObjects/interface/alpaka/SiPixelMappingUtilities.h"
0016 #include "DataFormats/FEDRawData/interface/FEDNumbering.h"
0017 #include "DataFormats/FEDRawData/interface/FEDRawData.h"
0018 #include "DataFormats/FEDRawData/interface/FEDRawDataCollection.h"
0019 #include "DataFormats/SiPixelClusterSoA/interface/alpaka/SiPixelClustersSoACollection.h"
0020 #include "DataFormats/SiPixelDigiSoA/interface/alpaka/SiPixelDigiErrorsSoACollection.h"
0021 #include "DataFormats/SiPixelDigiSoA/interface/alpaka/SiPixelDigisSoACollection.h"
0022 #include "DataFormats/SiPixelRawData/interface/SiPixelFormatterErrors.h"
0023 #include "EventFilter/SiPixelRawToDigi/interface/PixelDataFormatter.h"
0024 #include "EventFilter/SiPixelRawToDigi/interface/PixelUnpackingRegions.h"
0025 #include "FWCore/Framework/interface/ESWatcher.h"
0026 #include "FWCore/MessageLogger/interface/MessageLogger.h"
0027 #include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
0028 #include "FWCore/ParameterSet/interface/ParameterSet.h"
0029 #include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
0030 #include "FWCore/Utilities/interface/ESGetToken.h"
0031 #include "FWCore/Utilities/interface/InputTag.h"
0032 #include "HeterogeneousCore/AlpakaCore/interface/alpaka/EDPutToken.h"
0033 #include "HeterogeneousCore/AlpakaCore/interface/alpaka/ESGetToken.h"
0034 #include "HeterogeneousCore/AlpakaCore/interface/alpaka/Event.h"
0035 #include "HeterogeneousCore/AlpakaCore/interface/alpaka/stream/SynchronizingEDProducer.h"
0036 #include "HeterogeneousCore/AlpakaInterface/interface/config.h"
0037 #include "RecoLocalTracker/SiPixelClusterizer/interface/SiPixelClusterThresholds.h"
0038 
0039 #include "SiPixelRawToClusterKernel.h"
0040 
0041 namespace ALPAKA_ACCELERATOR_NAMESPACE {
0042 
0043   template <typename TrackerTraits>
0044   class SiPixelRawToCluster : public stream::SynchronizingEDProducer<> {
0045   public:
0046     explicit SiPixelRawToCluster(const edm::ParameterSet& iConfig);
0047     ~SiPixelRawToCluster() override = default;
0048 
0049     static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);
0050     using Algo = pixelDetails::SiPixelRawToClusterKernel<TrackerTraits>;
0051 
0052   private:
0053     void acquire(device::Event const& iEvent, device::EventSetup const& iSetup) override;
0054     void produce(device::Event& iEvent, device::EventSetup const& iSetup) override;
0055 
0056     edm::EDGetTokenT<FEDRawDataCollection> rawGetToken_;
0057     edm::EDPutTokenT<SiPixelFormatterErrors> fmtErrorToken_;
0058     device::EDPutToken<SiPixelDigisSoACollection> digiPutToken_;
0059     device::EDPutToken<SiPixelDigiErrorsSoACollection> digiErrorPutToken_;
0060     device::EDPutToken<SiPixelClustersSoACollection> clusterPutToken_;
0061 
0062     edm::ESWatcher<SiPixelFedCablingMapRcd> recordWatcher_;
0063     const device::ESGetToken<SiPixelMappingDevice, SiPixelMappingSoARecord> mapToken_;
0064     const device::ESGetToken<SiPixelGainCalibrationForHLTDevice, SiPixelGainCalibrationForHLTSoARcd> gainsToken_;
0065     const edm::ESGetToken<SiPixelFedCablingMap, SiPixelFedCablingMapRcd> cablingMapToken_;
0066 
0067     std::unique_ptr<SiPixelFedCablingTree> cabling_;
0068     std::vector<unsigned int> fedIds_;
0069     const SiPixelFedCablingMap* cablingMap_ = nullptr;
0070     std::unique_ptr<PixelUnpackingRegions> regions_;
0071 
0072     Algo Algo_;
0073     PixelDataFormatter::Errors errors_;
0074 
0075     const bool includeErrors_;
0076     const bool useQuality_;
0077     uint32_t nDigis_;
0078     const SiPixelClusterThresholds clusterThresholds_;
0079   };
0080 
0081   template <typename TrackerTraits>
0082   SiPixelRawToCluster<TrackerTraits>::SiPixelRawToCluster(const edm::ParameterSet& iConfig)
0083       : SynchronizingEDProducer(iConfig),
0084         rawGetToken_(consumes(iConfig.getParameter<edm::InputTag>("InputLabel"))),
0085         digiPutToken_(produces()),
0086         clusterPutToken_(produces()),
0087         mapToken_(esConsumes()),
0088         gainsToken_(esConsumes()),
0089         cablingMapToken_(esConsumes<SiPixelFedCablingMap, SiPixelFedCablingMapRcd>(
0090             edm::ESInputTag("", iConfig.getParameter<std::string>("CablingMapLabel")))),
0091         includeErrors_(iConfig.getParameter<bool>("IncludeErrors")),
0092         useQuality_(iConfig.getParameter<bool>("UseQualityInfo")),
0093         clusterThresholds_{iConfig.getParameter<int32_t>("clusterThreshold_layer1"),
0094                            iConfig.getParameter<int32_t>("clusterThreshold_otherLayers"),
0095                            static_cast<float>(iConfig.getParameter<double>("VCaltoElectronGain")),
0096                            static_cast<float>(iConfig.getParameter<double>("VCaltoElectronGain_L1")),
0097                            static_cast<float>(iConfig.getParameter<double>("VCaltoElectronOffset")),
0098                            static_cast<float>(iConfig.getParameter<double>("VCaltoElectronOffset_L1"))} {
0099     if (includeErrors_) {
0100       digiErrorPutToken_ = produces();
0101       fmtErrorToken_ = produces();
0102     }
0103 
0104     // regions
0105     if (!iConfig.getParameter<edm::ParameterSet>("Regions").getParameterNames().empty()) {
0106       regions_ = std::make_unique<PixelUnpackingRegions>(iConfig, consumesCollector());
0107     }
0108   }
0109 
0110   template <typename TrackerTraits>
0111   void SiPixelRawToCluster<TrackerTraits>::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
0112     edm::ParameterSetDescription desc;
0113     desc.add<bool>("IncludeErrors", true);
0114     desc.add<bool>("UseQualityInfo", false);
0115     // Note: this parameter is obsolete: it is ignored and will have no effect.
0116     // It is kept to avoid breaking older configurations, and will not be printed in the generated cfi.py file.
0117     desc.addOptionalNode(edm::ParameterDescription<uint32_t>("MaxFEDWords", 0, true), false)
0118         ->setComment("This parameter is obsolete and will be ignored.");
0119     desc.add<int32_t>("clusterThreshold_layer1", pixelClustering::clusterThresholdLayerOne);
0120     desc.add<int32_t>("clusterThreshold_otherLayers", pixelClustering::clusterThresholdOtherLayers);
0121     desc.add<double>("VCaltoElectronGain", 47.f);
0122     desc.add<double>("VCaltoElectronGain_L1", 50.f);
0123     desc.add<double>("VCaltoElectronOffset", -60.f);
0124     desc.add<double>("VCaltoElectronOffset_L1", -670.f);
0125 
0126     desc.add<edm::InputTag>("InputLabel", edm::InputTag("rawDataCollector"));
0127     {
0128       edm::ParameterSetDescription psd0;
0129       psd0.addOptional<std::vector<edm::InputTag>>("inputs");
0130       psd0.addOptional<std::vector<double>>("deltaPhi");
0131       psd0.addOptional<std::vector<double>>("maxZ");
0132       psd0.addOptional<edm::InputTag>("beamSpot");
0133       desc.add<edm::ParameterSetDescription>("Regions", psd0)
0134           ->setComment("## Empty Regions PSet means complete unpacking");
0135     }
0136     desc.add<std::string>("CablingMapLabel", "")->setComment("CablingMap label");  //Tav
0137     descriptions.addWithDefaultLabel(desc);
0138   }
0139 
0140   template <typename TrackerTraits>
0141   void SiPixelRawToCluster<TrackerTraits>::acquire(device::Event const& iEvent, device::EventSetup const& iSetup) {
0142     auto const& hMap = iSetup.getData(mapToken_);
0143     auto const& dGains = iSetup.getData(gainsToken_);
0144 
0145     // initialize cabling map or update if necessary
0146     if (recordWatcher_.check(iSetup)) {
0147       // cabling map, which maps online address (fed->link->ROC->local pixel) to offline (DetId->global pixel)
0148       cablingMap_ = &iSetup.getData(cablingMapToken_);
0149       fedIds_ = cablingMap_->fedIds();
0150       cabling_ = cablingMap_->cablingTree();
0151       LogDebug("map version:") << cablingMap_->version();
0152     }
0153 
0154     // if used, the buffer is guaranteed to stay alive until the after the execution of makePhase1ClustersAsync completes
0155     std::optional<cms::alpakatools::device_buffer<Device, unsigned char[]>> modulesToUnpackRegional;
0156     const unsigned char* modulesToUnpack;
0157     if (regions_) {
0158       regions_->run(iEvent, iSetup);
0159       LogDebug("SiPixelRawToCluster") << "region2unpack #feds: " << regions_->nFEDs();
0160       LogDebug("SiPixelRawToCluster") << "region2unpack #modules (BPIX,EPIX,total): " << regions_->nBarrelModules()
0161                                       << " " << regions_->nForwardModules() << " " << regions_->nModules();
0162 
0163       modulesToUnpackRegional = SiPixelMappingUtilities::getModToUnpRegionalAsync(
0164           *(regions_->modulesToUnpack()), cabling_.get(), fedIds_, iEvent.queue());
0165       modulesToUnpack = modulesToUnpackRegional->data();
0166     } else {
0167       modulesToUnpack = hMap->modToUnpDefault();
0168     }
0169 
0170     const auto& buffers = iEvent.get(rawGetToken_);
0171 
0172     errors_.clear();
0173 
0174     // GPU specific: Data extraction for RawToDigi GPU
0175     unsigned int wordCounter = 0;
0176     unsigned int fedCounter = 0;
0177     bool errorsInEvent = false;
0178     std::vector<unsigned int> index(fedIds_.size(), 0);
0179     std::vector<cms_uint32_t const*> start(fedIds_.size(), nullptr);
0180     std::vector<ptrdiff_t> words(fedIds_.size(), 0);
0181     // In CPU algorithm this loop is part of PixelDataFormatter::interpretRawData()
0182     ErrorChecker errorcheck;
0183     for (uint32_t i = 0; i < fedIds_.size(); ++i) {
0184       const int fedId = fedIds_[i];
0185       if (regions_ && !regions_->mayUnpackFED(fedId))
0186         continue;
0187 
0188       // for GPU
0189       // first 150 index stores the fedId and next 150 will store the
0190       // start index of word in that fed
0191       assert(fedId >= FEDNumbering::MINSiPixeluTCAFEDID);
0192       fedCounter++;
0193 
0194       // get event data for this fed
0195       const FEDRawData& rawData = buffers.FEDData(fedId);
0196 
0197       // GPU specific
0198       int nWords = rawData.size() / sizeof(cms_uint64_t);
0199       if (nWords == 0) {
0200         continue;
0201       }
0202       // check CRC bit
0203       const cms_uint64_t* trailer = reinterpret_cast<const cms_uint64_t*>(rawData.data()) + (nWords - 1);
0204       if (not errorcheck.checkCRC(errorsInEvent, fedId, trailer, errors_)) {
0205         continue;
0206       }
0207       // check headers
0208       const cms_uint64_t* header = reinterpret_cast<const cms_uint64_t*>(rawData.data());
0209       header--;
0210       bool moreHeaders = true;
0211       while (moreHeaders) {
0212         header++;
0213         bool headerStatus = errorcheck.checkHeader(errorsInEvent, fedId, header, errors_);
0214         moreHeaders = headerStatus;
0215       }
0216 
0217       // check trailers
0218       bool moreTrailers = true;
0219       trailer++;
0220       while (moreTrailers) {
0221         trailer--;
0222         bool trailerStatus = errorcheck.checkTrailer(errorsInEvent, fedId, nWords, trailer, errors_);
0223         moreTrailers = trailerStatus;
0224       }
0225 
0226       const cms_uint32_t* bw = (const cms_uint32_t*)(header + 1);
0227       const cms_uint32_t* ew = (const cms_uint32_t*)(trailer);
0228 
0229       assert(0 == (ew - bw) % 2);
0230       index[i] = wordCounter;
0231       start[i] = bw;
0232       words[i] = (ew - bw);
0233       wordCounter += (ew - bw);
0234 
0235     }  // end of for loop
0236     nDigis_ = wordCounter;
0237     if (nDigis_ == 0)
0238       return;
0239 
0240     // copy the FED data to a single cpu buffer
0241     pixelDetails::WordFedAppender wordFedAppender(iEvent.queue(), nDigis_);
0242     for (uint32_t i = 0; i < fedIds_.size(); ++i) {
0243       wordFedAppender.initializeWordFed(fedIds_[i], index[i], start[i], words[i]);
0244     }
0245     Algo_.makePhase1ClustersAsync(iEvent.queue(),
0246                                   clusterThresholds_,
0247                                   hMap.const_view(),
0248                                   modulesToUnpack,
0249                                   dGains.const_view(),
0250                                   wordFedAppender,
0251                                   wordCounter,
0252                                   fedCounter,
0253                                   useQuality_,
0254                                   includeErrors_,
0255                                   edm::MessageDrop::instance()->debugEnabled);
0256   }
0257 
0258   template <typename TrackerTraits>
0259   void SiPixelRawToCluster<TrackerTraits>::produce(device::Event& iEvent, device::EventSetup const& iSetup) {
0260     if (nDigis_ == 0) {
0261       // Cannot use the default constructor here, as it would not allocate memory.
0262       // In the case of no digis, clusters_d are not being instantiated, but are
0263       // still used downstream to initialize TrackingRecHitSoADevice. If there
0264       // are no valid pointers to clusters' Collection columns, instantiation
0265       // of TrackingRecHits fail. Example: workflow 11604.0
0266 
0267       iEvent.emplace(digiPutToken_, 0, iEvent.queue());
0268       iEvent.emplace(clusterPutToken_, pixelTopology::Phase1::numberOfModules, iEvent.queue());
0269       if (includeErrors_) {
0270         iEvent.emplace(digiErrorPutToken_, 0, iEvent.queue());
0271         iEvent.emplace(fmtErrorToken_);
0272       }
0273       return;
0274     }
0275 
0276     iEvent.emplace(digiPutToken_, Algo_.getDigis());
0277     iEvent.emplace(clusterPutToken_, Algo_.getClusters());
0278     if (includeErrors_) {
0279       iEvent.emplace(digiErrorPutToken_, Algo_.getErrors());
0280       iEvent.emplace(fmtErrorToken_, std::move(errors_));
0281     }
0282   }
0283 
0284   using SiPixelRawToClusterPhase1 = SiPixelRawToCluster<pixelTopology::Phase1>;
0285   using SiPixelRawToClusterHIonPhase1 = SiPixelRawToCluster<pixelTopology::HIonPhase1>;
0286 
0287 }  // namespace ALPAKA_ACCELERATOR_NAMESPACE
0288 
0289 // define as framework plugin
0290 #include "HeterogeneousCore/AlpakaCore/interface/alpaka/MakerMacros.h"
0291 DEFINE_FWK_ALPAKA_MODULE(SiPixelRawToClusterPhase1);
0292 DEFINE_FWK_ALPAKA_MODULE(SiPixelRawToClusterHIonPhase1);