I/O Customizaton Rules: add support for changing the input type. #17347
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pcanal
requested review from
jblomer and
dpiparo
and removed request for
dpiparo
Test Results 18 files 18 suites 4d 1h 8m 31s ⏱️ Results for commit 1965fb4. ♻️ This comment has been updated with latest results. |
pcanal
force-pushed
the
io-rules-type-change
branch
from
ba28c30 to
7b3edc4
Compare
jblomer
reviewed
Jan 8, 2025
pcanal
force-pushed
the
io-rules-type-change
branch
2 times, most recently
from
5144078 to
285bcf6
Compare
Previously the call to RemoveStreamerInfo was working only if the slot was the the slot of the current version. (the actually removed StreamerInfo was hard-coded to be the current version
The data members are cached (because they are input of a rule) need to be read into the original type not the 'current in memory type' so that the rule can properly function if the type has changed. We should upgrade further for the in-memory type of the input of a rule to be the one specified in the rule independently of the onfile type and the final in-memory type.
pcanal
force-pushed
the
io-rules-type-change
branch
from
73a13c5 to
2e3d281
Compare
dpiparo
approved these changes
Jan 15, 2025
Return the underlying type and other piece and information separately
This reverts commit e900d32. Bug fix: I/O customization rules which missing input are no longer (inappropriately) run. We now properly warn if a rule is requesting an input that is not present in the StreamerInfo that the rule is being applied to. To avoid the warning in some cases (in particular the cases used to support `HepMC` and are located in `$ROOTSYS/etc/class.rules`) we introduce a new "attribute" for I/O customization rules: `CanIgnore:` When using this attribute the rule will be ignored if the input is missing from the schema/class-layout they apply to instead of issue a `Warning` wip: Revert "Don't warn when ..."
In TStreamerInfo's Build and BuildOld update the artificial StreamerElement's description of the in memory type to be used to store the data. This allows the rule to request an implicit transformation from onfile representation to in memory representation before running the explicit customization rules
This allows to remove data member whose type is array of (sub)objects.
dim needs to be 0 for non-array
Previously the code in TStreamerElement assumed that GetClassPointer return the underlying type of the in memory representation. This was true until recently as you could not change the representation in the 'current' StreamerInfo ( GetClassPointer was matching the layout as decribed by the Clang AST ) and if the class was not loaded, the 'old/onfile' representation was the only possible choice. However we now can change the representation on file (i.e. GetClassPointer) for the current StreamerInfo of a loaded class (i.e. later using Write rule, now in the case of enum class and collection thereof) and in the case of the synthetic/artifical class created to cache inputs of rules (they are named `classname@@versionNumber`), the rule now dictates the representation in memory
This patch allows to register rules on a class which dictionary is in a different dictionary source file. Introduce the internal functions: ROOT::TMetaUtils::WriteStandaloneReadRules ROOT::TMetaUtils::WriteRulesRegistration TClass::GetReadRulesRegistry TClass::RegisterReadRules
pcanal
force-pushed
the
io-rules-type-change
branch
2 times, most recently
from
6a3c4dc to
d481d2c
Compare
pcanal
force-pushed
the
io-rules-type-change
branch
from
d481d2c to
1965fb4
Compare
|
@pcanal , while testing this in cmssw , we get build error/warning like [a]. the classes_def.xml file is https://github.com/cms-sw/cmssw/blob/master/DataFormats/HcalIsolatedTrack/src/classes_def.xml . Do we need some cleanup in cmssw to avoid this warning? |
|
This indicates a 'real' error and the 2 rules whose Previously those rules were (likely) silently ignored. To enable them add something like |
thanks @pcanal , I will try this |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With these changes, one can request the schema evolution (usually implicit) of the input data members from the on-file type to a custom type. Example of the changes support in the test roottest/root/io/evolution/rules/execSourceTypes.cxx added by the companion roottest PR
This fixes #17346 17346