Clean up the pixel local reconstruction code

fwyzard commented 3 years ago

Address the pixel local reconstruction review comments from https://github.com/cms-sw/cmssw/pull/31721.

General clean up of the pixel local reconstruction code:

remove commented out and obsolete code and data members
use named constants more consistently
update variable names to follow the coding rules and for better consistency
use member initializer lists in the constructors
allow if constexpr in CUDA code
use std::size instead of hardcoding the array size
convert iterator-based loops to range-based loops
replace cout and printf with LogDebug or LogWarning
use put tokens
reorganise the auto-generated cfi files and use them more consistently
adjust code after rearranging an #ifdef GPU_DEBUG block
apply code formatting
other minor changes

Improve comments:

improve comments and remove obsolete ones
clarify comments and types regarding HostProduct
update comments about GPU_SMALL_EVENTS being kept for testing purposes
add notes about the original cpu code

Reuse some more common code:

move common pixel cluster code to PixelClusterizerBase
extend the SiPixelCluster constructor

Rename classes and modules for better consistency:

remove the TrackingRecHit2DCUDA.h and gpuClusteringConstants.h forwarding headers
rename PixelRecHits to PixelRecHitGPUKernel
rename SiPixelRecHitFromSOA to SiPixelRecHitFromCUDA
rename siPixelClustersCUDAPreSplitting to siPixelClustersPreSplittingCUDA
rename siPixelRecHitsCUDAPreSplitting to siPixelRecHitsPreSplittingCUDA
rename siPixelRecHitsLegacyPreSplitting to siPixelRecHitsPreSplittingLegacy
rename siPixelRecHitHostSoA to siPixelRecHitSoAFromLegacy

Re-apply changes from #29805 that were lost in the Patatrack branch.

VinInn commented 3 years ago

I do not disagree. Still some of those were just straight copies from Legacy

fwyzard commented 3 years ago

Validation summary

Reference release CMSSW_11_2_0_pre10 at 6c149b2963ee Development branch cms-patatrack/master at 6a192beda960 Testing branch cms-patatrack/master at 6a192beda960 with PRs:

593 at 43edd12b5d8e

Validation plots

/RelValTTbar_14TeV/CMSSW_11_2_0_pre7-PU_112X_mcRun3_2021_realistic_v8-v1/GEN-SIM-DIGI-RAW

tracking validation plots and summary for workflow 11634.5
tracking validation plots and summary for workflow 11634.501
tracking validation plots and summary for workflow 11634.502
tracking validation plots and summary for workflow 11634.505
tracking validation plots and summary for workflow 11634.506

/RelValZMM_14/CMSSW_11_2_0_pre7-112X_mcRun3_2021_realistic_v8-v2/GEN-SIM-DIGI-RAW

tracking validation plots and summary for workflow 11634.5
tracking validation plots and summary for workflow 11634.501
tracking validation plots and summary for workflow 11634.502
tracking validation plots and summary for workflow 11634.505
tracking validation plots and summary for workflow 11634.506

/RelValZEE_14/CMSSW_11_2_0_pre7-112X_mcRun3_2021_realistic_v8-v1/GEN-SIM-DIGI-RAW

tracking validation plots and summary for workflow 11634.5
tracking validation plots and summary for workflow 11634.501
tracking validation plots and summary for workflow 11634.502
tracking validation plots and summary for workflow 11634.505
tracking validation plots and summary for workflow 11634.506

Validation plots (CPU vs GPU)

/RelValTTbar_14TeV/CMSSW_11_2_0_pre7-PU_112X_mcRun3_2021_realistic_v8-v1/GEN-SIM-DIGI-RAW

tracking validation plots and summary for workflows 11634.502 and 11634.501
tracking validation plots and summary for workflows 11634.506 and 11634.505

/RelValZMM_14/CMSSW_11_2_0_pre7-112X_mcRun3_2021_realistic_v8-v2/GEN-SIM-DIGI-RAW

tracking validation plots and summary for workflows 11634.502 and 11634.501
tracking validation plots and summary for workflows 11634.506 and 11634.505

/RelValZEE_14/CMSSW_11_2_0_pre7-112X_mcRun3_2021_realistic_v8-v1/GEN-SIM-DIGI-RAW

tracking validation plots and summary for workflows 11634.502 and 11634.501
tracking validation plots and summary for workflows 11634.506 and 11634.505

Throughput plots

/EphemeralHLTPhysics1/Run2018D-v1/RAW run=323775 lumi=53

scan-136.885502.png zoom-136.885502.png scan-136.885512.png zoom-136.885512.png scan-136.885522.png zoom-136.885522.png

logs and `nvprof`/`nvvp` profiles

/RelValTTbar_14TeV/CMSSW_11_2_0_pre7-PU_112X_mcRun3_2021_realistic_v8-v1/GEN-SIM-DIGI-RAW

reference release, workflow 11634.5
- :heavy_check_mark: step3.py: log
development release, workflow 11634.5
- :heavy_check_mark: step3.py: log
development release, workflow 11634.501
- :heavy_check_mark: step3.py: log
development release, workflow 11634.502
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
development release, workflow 11634.505
- :heavy_check_mark: step3.py: log
development release, workflow 11634.506
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
development release, workflow 11634.511
- :heavy_check_mark: step3.py: log
development release, workflow 11634.512
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :x: cuda-memcheck --tool synccheck (report, log) found no CUDA-MEMCHECK results
development release, workflow 11634.521
- :heavy_check_mark: step3.py: log
development release, workflow 11634.522
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
development release, workflow 136.885502
development release, workflow 136.885512
development release, workflow 136.885522
testing release, workflow 11634.5
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.501
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.502
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
testing release, workflow 11634.505
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.506
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
testing release, workflow 11634.511
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.512
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :x: cuda-memcheck --tool synccheck (report, log) found no CUDA-MEMCHECK results
testing release, workflow 11634.521
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.522
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
testing release, workflow 136.885502
testing release, workflow 136.885512
testing release, workflow 136.885522

/RelValZMM_14/CMSSW_11_2_0_pre7-112X_mcRun3_2021_realistic_v8-v2/GEN-SIM-DIGI-RAW

reference release, workflow 11634.5
- :heavy_check_mark: step3.py: log
development release, workflow 11634.5
- :heavy_check_mark: step3.py: log
development release, workflow 11634.501
- :heavy_check_mark: step3.py: log
development release, workflow 11634.502
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
development release, workflow 11634.505
- :heavy_check_mark: step3.py: log
development release, workflow 11634.506
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
development release, workflow 11634.511
- :heavy_check_mark: step3.py: log
development release, workflow 11634.512
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :x: cuda-memcheck --tool synccheck (report, log) found no CUDA-MEMCHECK results
development release, workflow 11634.521
- :heavy_check_mark: step3.py: log
development release, workflow 11634.522
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
development release, workflow 136.885502
development release, workflow 136.885512
development release, workflow 136.885522
testing release, workflow 11634.5
- :x: step3.py: log
testing release, workflow 11634.501
- :x: step3.py: log
testing release, workflow 11634.502
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
testing release, workflow 11634.505
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.506
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
testing release, workflow 11634.511
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.512
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :x: cuda-memcheck --tool synccheck (report, log) found no CUDA-MEMCHECK results
testing release, workflow 11634.521
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.522
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
testing release, workflow 136.885502
testing release, workflow 136.885512
testing release, workflow 136.885522

/RelValZEE_14/CMSSW_11_2_0_pre7-112X_mcRun3_2021_realistic_v8-v1/GEN-SIM-DIGI-RAW

reference release, workflow 11634.5
- :heavy_check_mark: step3.py: log
development release, workflow 11634.5
- :heavy_check_mark: step3.py: log
development release, workflow 11634.501
- :heavy_check_mark: step3.py: log
development release, workflow 11634.502
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
development release, workflow 11634.505
- :heavy_check_mark: step3.py: log
development release, workflow 11634.506
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
development release, workflow 11634.511
- :heavy_check_mark: step3.py: log
development release, workflow 11634.512
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :x: cuda-memcheck --tool synccheck (report, log) found no CUDA-MEMCHECK results
development release, workflow 11634.521
- :heavy_check_mark: step3.py: log
development release, workflow 11634.522
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
development release, workflow 136.885502
development release, workflow 136.885512
development release, workflow 136.885522
testing release, workflow 11634.5
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.501
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.502
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
testing release, workflow 11634.505
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.506
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool synccheck (report, log) did not find any errors
testing release, workflow 11634.511
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.512
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :heavy_check_mark: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) did not find any errors
- :x: cuda-memcheck --tool synccheck (report, log) found no CUDA-MEMCHECK results
testing release, workflow 11634.521
- :heavy_check_mark: step3.py: log
testing release, workflow 11634.522
- :heavy_check_mark: step3.py: log
- :heavy_check_mark: profile.py: log
- :heavy_check_mark: cuda-memcheck --tool initcheck (report, log) did not find any errors
- :x: cuda-memcheck --tool memcheck --leak-check full --report-api-errors all (report, log) found 0 errors
- :x: cuda-memcheck --tool synccheck (report, log) found 0 errors
testing release, workflow 136.885502
testing release, workflow 136.885512
testing release, workflow 136.885522

Logs

The full log is available at https://patatrack.web.cern.ch/patatrack/validation/pulls/023f858d9a6a894e3756d039de0da81d3b22a10f/log .

fwyzard commented 3 years ago

No impact on physics (as expected). No regressions on throughput (as expected) when running by hand.

cms-patatrack / cmssw