[Backport to 20_0_X (#50691)] SoA Schema evolution by Electricks94 · Pull Request #51315 · cms-sw/cmssw

Electricks94 · 2026-06-25T07:31:40Z

PR description:

Extension of the custom streamer of the SoA Backend to encounter for the following cases:

Added columns/eigen columns/scalars are initialised to 0
Removed or rearranged columns are handle correctly by ROOT
columns with changed type (e.g. double to float) are handle by ROOTm this holds also for Eigen columns and scalars
Eigen columns with changed dimensions for example Eigen::Matrix<float, 4, 2> -> Eigen::Matrix<float, 3, 2>; result in a meaningfull error at reading
Columns with enum types are stored as integers in the SoA backend and only exposed as enums. Hence, the schema evolution behaves exactly like in the case of integers and also 8 byte large enums are supported which is not case with ROOT normally (see Add support for enums with non-default size root-project/root#17009)
Examples using ioread rules are provided to showcase how complex cases (e.g. using custom types for SoA columns) can be handled

PR validation:

A set of SoA Layouts is provided which evolve from a base SoA Layout. The base SoA Layout is stored multiple times using a different type alias which is then changed in the code to simulate an evolving class. The created ROOT files are then used to validate the reading of the previously stored Collections.

This PR is an extension of #50487

If this PR is a backport please specify the original PR and why you need to backport that PR. If this PR will be backported please specify to which release cycle the backport is meant for:

This is a backport of #50691 to 20_0_X

@felicepantaleo fyi

cmsbuild · 2026-06-25T07:32:11Z

A new Pull Request was created by @Electricks94 for CMSSW_20_0_X.

It involves the following packages:

DataFormats/Portable (heterogeneous)
DataFormats/SoATemplate (heterogeneous)
HeterogeneousCore/TestModules (****)

The following packages do not have a category, yet:

HeterogeneousCore/TestModules
Please create a PR for https://github.com/cms-sw/cms-bot/blob/master/categories_map.py to assign category

@cmsbuild, @fwyzard, @makortel can you please review it and eventually sign? Thanks.
@makortel, @missirol, @mmusich, @rovere this is something you requested to watch as well.
@ftenchini, @mandrenguyen, @sextonkennedy you are the release manager for this.

cms-bot commands are listed here

Backported from SoA Schema evolution #50691

cmsbuild · 2026-06-25T07:32:12Z

cms-bot internal usage

fwyzard · 2026-06-25T13:27:20Z

type ngt

fwyzard · 2026-06-25T13:27:26Z

backport #50691

fwyzard · 2026-06-25T13:29:19Z

urgent

It would be good to include this in 20.0.0, as it makes the schema evolution of the SoA dataformats more robust.
So if there any SoA included in the MC production, this would make the samples more forward-compatible.

fwyzard · 2026-06-25T13:29:30Z

enable gpu

fwyzard · 2026-06-25T13:29:34Z

please test

fwyzard · 2026-06-25T14:40:29Z

+heterogeneous

cmsbuild · 2026-06-25T16:47:34Z

-1

Failed Tests: RelVals-AMD_MI300X
Size: This PR adds an extra 16KB to repository
Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-13d381/54271/summary.html
COMMIT: f0c1f8e
CMSSW: CMSSW_20_0_X_2026-06-25-1100/el8_amd64_gcc13
Additional Tests: GPU,AMD_MI300X,AMD_W7900,NVIDIA_H100,NVIDIA_L40S,NVIDIA_T4
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week1/cms-sw/cmssw/51315/54271/install.sh to create a dev area with all the needed externals and cmssw changes.

Failed RelVals-AMD_MI300X

34434.40334434.403_TTbar_14TeV+Run4D121_Patatrack_PixelOnlyAlpaka_Validation/step2_TTbar_14TeV+Run4D121_Patatrack_PixelOnlyAlpaka_Validation.log

Comparison Summary

Summary:

No significant changes to the logs found
Reco comparison results: 0 differences found in the comparisons
DQMHistoTests: Total files compared: 44
DQMHistoTests: Total histograms compared: 3248390
DQMHistoTests: Total failures: 30
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 3248342
DQMHistoTests: Total skipped: 18
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 43 files compared)
Checked 191 log files, 159 edm output root files, 44 DQM output files
TriggerResults: no differences found

AMD_W7900 Comparison Summary

Summary:

No significant changes to the logs found
Reco comparison results: 138 differences found in the comparisons
DQMHistoTests: Total files compared: 7
DQMHistoTests: Total histograms compared: 163207
DQMHistoTests: Total failures: 21196
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 142011
DQMHistoTests: Total skipped: 0
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 6 files compared)
Checked 25 log files, 20 edm output root files, 7 DQM output files
TriggerResults: no differences found

NVIDIA_H100 Comparison Summary

Summary:

No significant changes to the logs found
Reco comparison results: 95 differences found in the comparisons
DQMHistoTests: Total files compared: 7
DQMHistoTests: Total histograms compared: 163207
DQMHistoTests: Total failures: 17399
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 145808
DQMHistoTests: Total skipped: 0
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 6 files compared)
Checked 25 log files, 20 edm output root files, 7 DQM output files
TriggerResults: no differences found

NVIDIA_L40S Comparison Summary

Summary:

No significant changes to the logs found
Reco comparison results: 133 differences found in the comparisons
DQMHistoTests: Total files compared: 7
DQMHistoTests: Total histograms compared: 163207
DQMHistoTests: Total failures: 16408
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 146799
DQMHistoTests: Total skipped: 0
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 6 files compared)
Checked 25 log files, 20 edm output root files, 7 DQM output files
TriggerResults: no differences found

NVIDIA_T4 Comparison Summary

Summary:

No significant changes to the logs found
Reco comparison results: 127 differences found in the comparisons
DQMHistoTests: Total files compared: 7
DQMHistoTests: Total histograms compared: 163207
DQMHistoTests: Total failures: 11630
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 151577
DQMHistoTests: Total skipped: 0
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 6 files compared)
Checked 25 log files, 20 edm output root files, 7 DQM output files
TriggerResults: no differences found

Max Memory Comparisons exceeding threshold NVIDIA_H100

@cms-sw/core-l2 , I found 1 workflow step(s) with memory usage exceeding the error threshold:

Expand to see workflows ...

Error: Workflow 34434.7503_TTbar_14TeV+Run4D121_HLTHeterogeneousValid step2 max memory diff 273.9 exceeds +/- 30.0 MiB

fwyzard · 2026-06-26T09:09:21Z

The MI300X failure is a timeout, let's try again.

fwyzard · 2026-06-26T09:09:26Z

please test

cmsbuild · 2026-06-26T11:25:36Z

-1

Failed Tests: amd_w7900UnitTests
Size: This PR adds an extra 16KB to repository
Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-13d381/54300/summary.html
COMMIT: f0c1f8e
CMSSW: CMSSW_20_0_X_2026-06-25-2300/el8_amd64_gcc13
Additional Tests: GPU,AMD_MI300X,AMD_W7900,NVIDIA_H100,NVIDIA_L40S,NVIDIA_T4
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week1/cms-sw/cmssw/51315/54300/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

No significant changes to the logs found
Reco comparison results: 0 differences found in the comparisons
DQMHistoTests: Total files compared: 44
DQMHistoTests: Total histograms compared: 3248390
DQMHistoTests: Total failures: 32
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 3248340
DQMHistoTests: Total skipped: 18
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 43 files compared)
Checked 191 log files, 159 edm output root files, 44 DQM output files
TriggerResults: no differences found

AMD_MI300X Comparison Summary

Summary:

No significant changes to the logs found
Reco comparison results: 147 differences found in the comparisons
DQMHistoTests: Total files compared: 7
DQMHistoTests: Total histograms compared: 163207
DQMHistoTests: Total failures: 13573
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 149634
DQMHistoTests: Total skipped: 0
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 6 files compared)
Checked 25 log files, 20 edm output root files, 7 DQM output files
TriggerResults: no differences found

NVIDIA_H100 Comparison Summary

Summary:

No significant changes to the logs found
Reco comparison results: 79 differences found in the comparisons
DQMHistoTests: Total files compared: 7
DQMHistoTests: Total histograms compared: 163207
DQMHistoTests: Total failures: 15540
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 147667
DQMHistoTests: Total skipped: 0
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 6 files compared)
Checked 25 log files, 20 edm output root files, 7 DQM output files
TriggerResults: no differences found

NVIDIA_L40S Comparison Summary

Summary:

No significant changes to the logs found
Reco comparison results: 168 differences found in the comparisons
DQMHistoTests: Total files compared: 7
DQMHistoTests: Total histograms compared: 163207
DQMHistoTests: Total failures: 17550
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 145657
DQMHistoTests: Total skipped: 0
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 6 files compared)
Checked 25 log files, 20 edm output root files, 7 DQM output files
TriggerResults: no differences found

NVIDIA_T4 Comparison Summary

Summary:

No significant changes to the logs found
Reco comparison results: 206 differences found in the comparisons
DQMHistoTests: Total files compared: 7
DQMHistoTests: Total histograms compared: 163207
DQMHistoTests: Total failures: 23034
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 140173
DQMHistoTests: Total skipped: 0
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 6 files compared)
Checked 25 log files, 20 edm output root files, 7 DQM output files
TriggerResults: no differences found

fwyzard and others added 10 commits June 25, 2026 09:25

Extend SoA read streamer to support schema evolution

2417861

Start working on test

7f9a46b

Added check for Eigen type evolution

ed40d72

Store enum as integer in SoA backend

8a80538

Added test case

7091b39

Added test cases and documentation to SoA schema evolution

37cb598

Extended Schema Evolution with custom io rules

baf93cf

Extended Documentation

ed49365

Move Schemaevolution tests to HeterogeniousCore

0f0a403

made README in DataFormats Portable clearer

f0c1f8e

cmsbuild added this to the CMSSW_20_0_X milestone Jun 25, 2026

cmsbuild added pending-signatures tests-pending orp-pending new-package-pending heterogeneous-pending changes-dataformats labels Jun 25, 2026

cmsbuild added backport ngt labels Jun 25, 2026

cmsbuild added tests-started urgent and removed tests-pending labels Jun 25, 2026

cmsbuild added heterogeneous-approved and removed heterogeneous-pending labels Jun 25, 2026

cmsbuild added tests-rejected and removed tests-started labels Jun 25, 2026

cmsbuild added tests-started and removed tests-rejected labels Jun 26, 2026

cmsbuild added tests-rejected and removed tests-started labels Jun 26, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Backport to 20_0_X (#50691)] SoA Schema evolution#51315

[Backport to 20_0_X (#50691)] SoA Schema evolution#51315
Electricks94 wants to merge 10 commits into
cms-sw:CMSSW_20_0_Xfrom
Electricks94:SoASerialisation_200X

Electricks94 commented Jun 25, 2026

Uh oh!

cmsbuild commented Jun 25, 2026 •

edited

Loading

Uh oh!

cmsbuild commented Jun 25, 2026 •

edited

Loading

Uh oh!

fwyzard commented Jun 25, 2026

Uh oh!

fwyzard commented Jun 25, 2026

Uh oh!

fwyzard commented Jun 25, 2026

Uh oh!

fwyzard commented Jun 25, 2026

Uh oh!

fwyzard commented Jun 25, 2026

Uh oh!

fwyzard commented Jun 25, 2026

Uh oh!

cmsbuild commented Jun 25, 2026

Uh oh!

fwyzard commented Jun 26, 2026

Uh oh!

fwyzard commented Jun 26, 2026

Uh oh!

cmsbuild commented Jun 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Electricks94 commented Jun 25, 2026

Uh oh!

cmsbuild commented Jun 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cmsbuild commented Jun 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fwyzard commented Jun 25, 2026

Uh oh!

fwyzard commented Jun 25, 2026

Uh oh!

fwyzard commented Jun 25, 2026

Uh oh!

fwyzard commented Jun 25, 2026

Uh oh!

fwyzard commented Jun 25, 2026

Uh oh!

fwyzard commented Jun 25, 2026

Uh oh!

cmsbuild commented Jun 25, 2026

Failed RelVals-AMD_MI300X

Comparison Summary

AMD_W7900 Comparison Summary

NVIDIA_H100 Comparison Summary

NVIDIA_L40S Comparison Summary

NVIDIA_T4 Comparison Summary

Max Memory Comparisons exceeding threshold NVIDIA_H100

Uh oh!

fwyzard commented Jun 26, 2026

Uh oh!

fwyzard commented Jun 26, 2026

Uh oh!

cmsbuild commented Jun 26, 2026

Comparison Summary

AMD_MI300X Comparison Summary

NVIDIA_H100 Comparison Summary

NVIDIA_L40S Comparison Summary

NVIDIA_T4 Comparison Summary

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

cmsbuild commented Jun 25, 2026 •

edited

Loading

cmsbuild commented Jun 25, 2026 •

edited

Loading