Extended documentation and tests for SoA methods #49671

Electricks94 · 2025-12-18T15:43:28Z

PR description:

This PR modifies the test SoACustomizedMethods_t by adding SOA_HOST_DEVICE to all element methods. Doing so, the test is also extended as a CUDA, HIP and Alpaka version to show consistency. Furthermore, the documentation is extended to hint to users of the SoA to use SOA_HOST_DEVICE to ensure that element methods can be used in device kernels.

A similar idea was promoted previously in #49203 by using constexpr to ensure that functions can run in device kernels. However, as shown, this method is not feasible for us due to a bug in the nvcc compiler. Hence, with this PR #49203 can be closed.

@felicepantaleo fyi

cmsbuild · 2025-12-18T15:43:48Z

cms-bot internal usage

Electricks94 · 2025-12-18T15:43:53Z

type ngt

cmsbuild · 2025-12-18T15:44:52Z

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-49671/47223

cmsbuild · 2025-12-18T15:45:12Z

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

It involves the following packages:

DataFormats/Portable (heterogeneous)
DataFormats/SoATemplate (heterogeneous)

@cmsbuild, @fwyzard, @makortel can you please review it and eventually sign? Thanks.
@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

Electricks94 · 2026-01-20T09:56:08Z

ping

makortel · 2026-01-20T15:06:34Z

@cmsbuild, please test

cmsbuild · 2026-01-20T17:03:25Z

+1

Size: This PR adds an extra 16KB to repository
Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-b98190/50756/summary.html
COMMIT: f39007e
CMSSW: CMSSW_16_1_X_2026-01-20-1100/el8_amd64_gcc13
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week1/cms-sw/cmssw/49671/50756/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: 4 differences found in the comparisons
DQMHistoTests: Total files compared: 52
DQMHistoTests: Total histograms compared: 4025536
DQMHistoTests: Total failures: 3
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 4025513
DQMHistoTests: Total skipped: 20
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 51 files compared)
Checked 222 log files, 193 edm output root files, 52 DQM output files
TriggerResults: no differences found

fwyzard · 2026-01-24T12:53:01Z

DataFormats/SoATemplate/test/SoACustomizedMethods_t.cu

+GENERATE_SOA_LAYOUT(SoATemplate,
+                    SOA_COLUMN(float, x),
+                    SOA_COLUMN(float, y),
+                    SOA_COLUMN(float, z),
+                    SOA_COLUMN(double, v_x),
+                    SOA_COLUMN(double, v_y),
+                    SOA_COLUMN(double, v_z),
+
+                    SOA_ELEMENT_METHODS(
+
+                        SOA_HOST_DEVICE void normalise() {
+                          float norm_position = square_norm_position();
+                          if (norm_position > 0.0f) {
+                            x() /= norm_position;
+                            y() /= norm_position;
+                            z() /= norm_position;
+                          };
+                          double norm_velocity = square_norm_velocity();
+                          if (norm_velocity > 0.0f) {
+                            v_x() /= norm_velocity;
+                            v_y() /= norm_velocity;
+                            v_z() /= norm_velocity;
+                          };
+                        }),
+
+                    SOA_CONST_ELEMENT_METHODS(
+                        SOA_HOST_DEVICE float square_norm_position()
+                            const { return sqrt(x() * x() + y() * y() + z() * z()); };
+
+                        SOA_HOST_DEVICE double square_norm_velocity()
+                            const { return sqrt(v_x() * v_x() + v_y() * v_y() + v_z() * v_z()); };
+
+                        template <typename T1, typename T2>
+                        SOA_HOST_DEVICE static auto time(T1 pos, T2 vel) {
+                          if (!(vel == 0))
+                            return pos / vel;
+                          return 0.;
+                        }),
+
+                    SOA_SCALAR(int, detectorType))
+
+using SoA = SoATemplate<>;
+using SoAView = SoA::View;
+using SoAConstView = SoA::ConstView;


Can you move the SoA to a separate header file, and reuse it for all tests (CPU, CUDA, ROCm, and alpaka) ?

fwyzard · 2026-01-24T12:54:30Z

DataFormats/SoATemplate/test/BuildFile.xml

+<bin file="SoACustomizedMethods_t.cu" name="SoACustomizedMethodsCuda">
+  <use name="boost"/>
+  <use name="catch2"/>
+  <use name="cuda"/>
+  <use name="DataFormats/SoATemplate"/>
+</bin>


This should be wrapped in a <iftool name="cuda"> block.

fwyzard · 2026-01-24T12:54:42Z

DataFormats/SoATemplate/test/BuildFile.xml

+<bin file="SoACustomizedMethods_t.hip.cc" name="SoACustomizedMethodsHip">
+  <use name="boost"/>
+  <use name="catch2"/>
+  <use name="rocm"/>
+  <use name="DataFormats/SoATemplate"/>
+</bin>


This should be wrapped in a <iftool name="rocm"> block

cmsbuild · 2026-01-26T10:17:54Z

-code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-49671/47694

There are other open Pull requests which might conflict with changes you have proposed:
- File DataFormats/Portable/test/BuildFile.xml modified in PR(s): Added AoSWrapper and transposition function #49072
- File DataFormats/SoATemplate/README.md modified in PR(s): Added AoSWrapper and transposition function #49072, Document constexpr limitation for SoA custom methods #49203, [Draft] Allow users to set a valid data range for the SoA View #49204
- File DataFormats/SoATemplate/test/BuildFile.xml modified in PR(s): Added AoSWrapper and transposition function #49072
- File DataFormats/SoATemplate/test/SoACustomizedMethods_t.cc modified in PR(s): Document constexpr limitation for SoA custom methods #49203

Code check has found code style and quality issues which could be resolved by applying following patch(s)

code-format:
https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-49671/47694/code-format.patch
e.g. curl -k https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-49671/47694/code-format.patch | patch -p1
You can also run scram build code-format to apply code format directly

cmsbuild · 2026-01-26T10:23:05Z

Pull request #49671 was updated. @cmsbuild, @fwyzard, @makortel can you please check and sign again.

fwyzard · 2026-01-26T11:15:28Z

DataFormats/SoATemplate/test/SoADefinition_CustomizedMethods.h

@@ -0,0 +1,46 @@
+#include "DataFormats/SoATemplate/interface/SoALayout.h"


Can you add

#include <cmath>

for the use of sqrt() ?

fwyzard · 2026-01-26T11:15:58Z

DataFormats/SoATemplate/test/SoADefinition_CustomizedMethods.h

+
+                        template <typename T1, typename T2>
+                        SOA_HOST_DEVICE static auto time(T1 pos, T2 vel) {
+                          if (not(vel == 0))


why not more simply

Suggested change

if (not(vel == 0))

if (vel != 0)

?

cmsbuild · 2026-01-26T11:22:42Z

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-49671/47698

There are other open Pull requests which might conflict with changes you have proposed:
- File DataFormats/Portable/test/BuildFile.xml modified in PR(s): Added AoSWrapper and transposition function #49072
- File DataFormats/SoATemplate/README.md modified in PR(s): Added AoSWrapper and transposition function #49072, Document constexpr limitation for SoA custom methods #49203, [Draft] Allow users to set a valid data range for the SoA View #49204
- File DataFormats/SoATemplate/test/BuildFile.xml modified in PR(s): Added AoSWrapper and transposition function #49072
- File DataFormats/SoATemplate/test/SoACustomizedMethods_t.cc modified in PR(s): Document constexpr limitation for SoA custom methods #49203

cmsbuild · 2026-01-26T11:23:05Z

Pull request #49671 was updated. @cmsbuild, @fwyzard, @makortel can you please check and sign again.

fwyzard · 2026-01-26T11:25:39Z

please test

fwyzard · 2026-01-26T11:25:43Z

+heterogeneous

cmsbuild · 2026-01-26T11:26:01Z

This pull request is fully signed and it will be integrated in one of the next master IBs after it passes the integration tests. This pull request will now be reviewed by the release team before it's merged. @ftenchini, @sextonkennedy, @mandrenguyen (and backports should be raised in the release meeting by the corresponding L2)

cmsbuild · 2026-01-26T13:11:15Z

+1

Size: This PR adds an extra 24KB to repository
Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-b98190/50892/summary.html
COMMIT: 30d94e9
CMSSW: CMSSW_16_1_X_2026-01-26-1100/el8_amd64_gcc13
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week0/cms-sw/cmssw/49671/50892/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

You potentially removed 4 lines from the logs
Reco comparison results: 13 differences found in the comparisons
DQMHistoTests: Total files compared: 52
DQMHistoTests: Total histograms compared: 4025536
DQMHistoTests: Total failures: 58
DQMHistoTests: Total nulls: 0
DQMHistoTests: Total successes: 4025458
DQMHistoTests: Total skipped: 20
DQMHistoTests: Total Missing objects: 0
DQMHistoSizes: Histogram memory added: 0.0 KiB( 51 files compared)
Checked 222 log files, 193 edm output root files, 52 DQM output files
TriggerResults: no differences found

mandrenguyen · 2026-01-27T06:19:07Z

+1

cmsbuild added this to the CMSSW_16_1_X milestone Dec 18, 2025

cmsbuild added pending-signatures tests-pending orp-pending code-checks-pending heterogeneous-pending labels Dec 18, 2025

cmsbuild added the ngt label Dec 18, 2025

cmsbuild added code-checks-approved and removed code-checks-pending labels Dec 18, 2025

cmsbuild added tests-started and removed tests-pending labels Jan 20, 2026

cmsbuild added tests-approved and removed tests-started labels Jan 20, 2026

fwyzard reviewed Jan 24, 2026

View reviewed changes

Electricks94 force-pushed the MethodHostDevice branch from f39007e to d15197d Compare January 26, 2026 10:16

cmsbuild added tests-pending code-checks-pending and removed tests-approved code-checks-approved labels Jan 26, 2026

cmsbuild removed the code-checks-pending label Jan 26, 2026

cmsbuild added code-checks-approved and removed code-checks-pending labels Jan 26, 2026

fwyzard reviewed Jan 26, 2026

View reviewed changes

Extension for SoA Methods

30d94e9

Electricks94 force-pushed the MethodHostDevice branch from cfb5ee2 to 30d94e9 Compare January 26, 2026 11:21

cmsbuild added code-checks-pending and removed code-checks-approved labels Jan 26, 2026

cmsbuild added code-checks-approved and removed code-checks-pending labels Jan 26, 2026

cmsbuild added fully-signed tests-started heterogeneous-approved and removed pending-signatures tests-pending heterogeneous-pending labels Jan 26, 2026

cmsbuild added tests-approved and removed tests-started labels Jan 26, 2026

cmsbuild added orp-approved and removed orp-pending labels Jan 27, 2026

cmsbuild merged commit d678a0a into cms-sw:master Jan 27, 2026
10 checks passed

cmsbuild mentioned this pull request Jan 27, 2026

[ROOT639] Updated root to tip of branch master cms-sw/cmsdist#10296

Merged

		@@ -0,0 +1,46 @@
		#include "DataFormats/SoATemplate/interface/SoALayout.h"

Extended documentation and tests for SoA methods #49671

Extended documentation and tests for SoA methods #49671

Uh oh!

Conversation

Electricks94 commented Dec 18, 2025

Uh oh!

cmsbuild commented Dec 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Electricks94 commented Dec 18, 2025

Uh oh!

cmsbuild commented Dec 18, 2025

Uh oh!

cmsbuild commented Dec 18, 2025

Uh oh!

Electricks94 commented Jan 20, 2026

Uh oh!

makortel commented Jan 20, 2026

Uh oh!

cmsbuild commented Jan 20, 2026

Comparison Summary

Uh oh!

fwyzard Jan 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fwyzard Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

fwyzard Jan 24, 2026

Choose a reason for hiding this comment

Uh oh!

cmsbuild commented Jan 26, 2026

Uh oh!

cmsbuild commented Jan 26, 2026

Uh oh!

fwyzard Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

fwyzard Jan 26, 2026

Choose a reason for hiding this comment

Uh oh!

cmsbuild commented Jan 26, 2026

Uh oh!

cmsbuild commented Jan 26, 2026

Uh oh!

fwyzard commented Jan 26, 2026

Uh oh!

fwyzard commented Jan 26, 2026

Uh oh!

cmsbuild commented Jan 26, 2026

Uh oh!

cmsbuild commented Jan 26, 2026

Comparison Summary

Uh oh!

mandrenguyen commented Jan 27, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

cmsbuild commented Dec 18, 2025 •

edited

Loading

fwyzard Jan 24, 2026 •

edited

Loading