plugins/alpaka/SiPixelRawToCluster.cc

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