Add HardwareResourcesDescription class

[makortel]

PR description:

This PR adds a HardwareResourcesDescription class to hold the "hardware provenance" information (and thus is part of #30044). Given the plan to add the information to ProcessConfiguration by replacing the so-far-pratically-unused

cmssw/DataFormats/Provenance/interface/ProcessConfiguration.h

Line 58 in 75451d5

PassID passID_;

with this information, and to avoid any backwards or forwards compatibility issues, the HardwareResourcesDescription will be serialized to a string. For that purpose this PR adds a "compact string serializer" that serializes a list of std::strings and containers of std::strings into one string. A compact representation is achieved by using non-printable ASCII characters as the delimiters.

A following PR will replace the PassID with the HardwareResourcesDescription in the ProcessConfiguration interface.

Resolves cms-sw/framework-team#1172

PR validation:

Added unit tests work.

[cmsbuild]

cms-bot internal usage

[cmsbuild]

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-47175/43416

[cmsbuild]

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

It involves the following packages:

• DataFormats/Provenance (core)
• FWCore/Utilities (core)

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

cms-bot commands are listed here

[makortel]

@cmsbuild, please test

[cmsbuild]

+1

Size: This PR adds an extra 40KB to repository
Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-ffcf65/43936/summary.html
COMMIT: 875fcb4
CMSSW: CMSSW_15_0_X_2025-01-23-1100/el8_amd64_gcc12
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week1/cms-sw/cmssw/47175/43936/install.sh to create a dev area with all the needed externals and cmssw changes.

Comparison Summary

Summary:

• You potentially removed 1 lines from the logs
• Reco comparison results: 0 differences found in the comparisons
• DQMHistoTests: Total files compared: 49
• DQMHistoTests: Total histograms compared: 3819085
• DQMHistoTests: Total failures: 136
• DQMHistoTests: Total nulls: 0
• DQMHistoTests: Total successes: 3818929
• DQMHistoTests: Total skipped: 20
• DQMHistoTests: Total Missing objects: 0
• DQMHistoSizes: Histogram memory added: 0.0 KiB( 48 files compared)
• Checked 214 log files, 184 edm output root files, 49 DQM output files
• TriggerResults: no differences found

[makortel]

From discussion with @Dr15Jones

• Create a new package FWCore/AbstractServices and move ResourceInformation base class there
  • The new package would depend on DataFormats/Provenance
  • Eventually all other service base classes would be moved to the new package
• Change ResourceInformation::acceleratorTypes() to hold the contents of process.options.accelerators as strings
  • Despite being "stringly typing", it avoids having to update the code in ResourceInformationService every time we add (or test) a new accelerator type
• process.options.accelerators schema should be enforced
  • Best schema that can be enforced would be \w+-\w+ accompanied with documentation <type>-<vendor>, with the exception of cpu
  • Check the schema in both python and in ResourceInformationService
  • Python should guarantee the process.options.accelerators is sorted
    • Downstream could then use binary search
• Add a function hasGpuNvidia() to ResourceInformation

[cmsbuild]

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-47175/43468

[cmsbuild]

+code-checks

Logs: https://cmssdt.cern.ch/SDT/code-checks/cms-sw-PR-47175/43478

[cmsbuild]

Pull request #47175 was updated. @Dr15Jones, @cmsbuild, @makortel, @smuzaffar can you please check and sign again.

[makortel]

@cmsbuild, please test

[cmsbuild]

+1

Size: This PR adds an extra 40KB to repository
Summary: https://cmssdt.cern.ch/SDT/jenkins-artifacts/pull-request-integration/PR-ffcf65/44045/summary.html
COMMIT: 8cb6597
CMSSW: CMSSW_15_0_X_2025-01-29-1100/el8_amd64_gcc12
User test area: For local testing, you can use /cvmfs/cms-ci.cern.ch/week0/cms-sw/cmssw/47175/44045/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: 8 differences found in the comparisons
• DQMHistoTests: Total files compared: 50
• DQMHistoTests: Total histograms compared: 4016770
• DQMHistoTests: Total failures: 9
• DQMHistoTests: Total nulls: 0
• DQMHistoTests: Total successes: 4016741
• DQMHistoTests: Total skipped: 20
• DQMHistoTests: Total Missing objects: 0
• DQMHistoSizes: Histogram memory added: 0.0 KiB( 49 files compared)
• Checked 218 log files, 189 edm output root files, 50 DQM output files
• TriggerResults: no differences found

[makortel]

I noticed a comparison differences in workflow 17034.0 that must be spurious (as this PR only adds code that is not used outside unit tests). I opened an issue for that #47211 .

[makortel]

+core

[cmsbuild]

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

[mandrenguyen]

+1