Skip to content

Incorrect name normalization for template with size_t template argument #18363

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
1 task done
pcanal opened this issue Apr 11, 2025 · 1 comment · Fixed by #18464
Closed
1 task done

Incorrect name normalization for template with size_t template argument #18363

pcanal opened this issue Apr 11, 2025 · 1 comment · Fixed by #18464
Assignees
@pcanal
Labels
bug experiment Affects an experiment / reported by its software & computimng experts in:Cling in:Core Libraries in:Dictionaries priority:critical
Milestone
6.36.00

Comments

@pcanal
Copy link
Member

pcanal commented Apr 11, 2025 •
edited
Loading

Check duplicate issues.

  • Checked for duplicates

Description

This is issue is reported indirectly in cms-sw/cmssw#47697 where this bug lead to an unwanted and failing auto-parsing, leading to a crash as a consequence of the failed auto-parsing.

The root cause is that the name normalization of:

template <size_t I> struct Outer { template <size_t II> struct View {}; };
Outer<128>
Outer<128>::View<128>

is not consistently handled. During dictionary generation we end up with the following:

Outer<128>
Outer<128UL>::View<128>

Note the type suffix in 1 out of the 3 possibility ... when none is (currently) desired.

In the reported case this lead the TProtoClass for Outer<128>::View<128> to have the (normalized) name Outer<128UL>::View<128> while at run-time we look up Outer<128>::View<128> fail to find it in the rootpcm when using the normalized name interface and thus go through a phase of name normalization which (due to the same/similar failed lookup) leads to the need to load the class information in the interpreter (aka auto-parse its headers).

Reproducer

$ cat Objects.hxx 
#pragma once

namespace reco { 
template <size_t I, bool B> struct PFRecHitSoALayout {
  template <size_t II, bool B1, bool B2, bool B3> struct ViewTemplateFreeParams {};
  using View = ViewTemplateFreeParams<I, B, true, true>; 
}; 
using PFRecHitSoA = PFRecHitSoALayout<128UL,false>; // try with 128ul
}

static reco::PFRecHitSoA abc;
static reco::PFRecHitSoALayout<128UL,false> a2;

$ cat LinkDef.h 
#pragma link C++ class reco::PFRecHitSoA+;
#pragma link C++ class reco::PFRecHitSoA::View+;

$ cat Makefile 
all: libCmsSoa.so DataFormatsParticleFlowReco_x2r.cxx

DataFormatsParticleFlowReco_x2r.cxx:  Objects.hxx selection.xml
	rootcling --reflex -failOnWarnings -f -rml libCmsSoa.so -rmf libCmsSoa.rootmap  DataFormatsParticleFlowReco_x2r.cxx Objects.hxx selection.xml

libCmsSoa.so: DataFormatsParticleFlowReco_x2r.cxx
	g++ `root-config --cflags --libs` -o libCmsSoa.so -fPIC --shared DataFormatsParticleFlowReco_x2r.cxx

clean:
	rm -f libCmsSoa.so DataFormatsParticleFlowReco_x2r.cxx DataFormatsParticleFlowReco_x2r_rdict.pcm libCmsSoa.rootmap

$ root.exe -b -l DataFormatsParticleFlowReco_x2r_rdict.pcm -e 'TObjArray *arr = nullptr; arr = gFile->Get<TObjArray>("__ProtoClasses"); arr->ls()' -q

ROOT version

up to v6.34.08

Installation method

any

Operating system

any

Additional context

@makortel
@pcanal pcanal added bug experiment Affects an experiment / reported by its software & computimng experts in:Cling in:Core Libraries in:Dictionaries priority:critical labels Apr 11, 2025
@pcanal pcanal added this to the 6.36.00 milestone Apr 11, 2025
@pcanal pcanal self-assigned this Apr 11, 2025
pcanal added a commit to pcanal/root that referenced this issue Apr 11, 2025
@pcanal
meta: Use Policy.NeverIncludeTypeForTemplateArgument.
a752074 
This solves problems caused by some code paths producing normalized name with unexpectedly
added type suffix after on integral non-type template parameters.

This fixes root-project#18363
This was referenced Apr 11, 2025
Closed
Open
pcanal added a commit to pcanal/root that referenced this issue Apr 12, 2025
@pcanal
meta: Use Policy.NeverIncludeTypeForTemplateArgument.
54684f1 
This solves problems caused by some code paths producing normalized name with unexpectedly
added type suffix after on integral non-type template parameters.

This fixes root-project#18363
pcanal added a commit to pcanal/root that referenced this issue Apr 14, 2025
@pcanal
meta: Use Policy.NeverIncludeTypeForTemplateArgument.
d3f4129 
This solves problems caused by some code paths producing normalized name with unexpectedly
added type suffix after on integral non-type template parameters.

This fixes root-project#18363
@hahnjo hahnjo mentioned this issue Apr 29, 2025
Merged
hahnjo added a commit to hahnjo/root that referenced this issue May 6, 2025
@hahnjo
[clang] Forward TPL of NestedNameSpecifier
5962c61 
This avoids type suffixes for integer constants when the type can be
inferred from the template parameter.

Closes root-project#18363
hahnjo added a commit to hahnjo/root that referenced this issue May 6, 2025
@hahnjo @pcanal
Add roottest for issue root-project#18363
fc8c421 
Co-authored-by: Philippe Canal <[email protected]>
@hahnjo hahnjo closed this as completed in 982f5d7 May 6, 2025
@github-actions GitHub Actions
Copy link

github-actions bot commented May 7, 2025

Hi @hahnjo, @pcanal,

It appears this issue is closed, but wasn't yet added to a project. Please add upcoming versions that will include the fix, or 'not applicable' otherwise.

Sincerely,
🤖

hahnjo added a commit to hahnjo/roottest that referenced this issue May 7, 2025
@hahnjo @pcanal
Add roottest for name normalization issue
0a0fe30 
root-project/root#18363

Co-authored-by: Philippe Canal <[email protected]>
@hahnjo hahnjo mentioned this issue May 7, 2025
Merged
hahnjo added a commit to hahnjo/root that referenced this issue May 7, 2025
@hahnjo
[clang] Forward TPL of NestedNameSpecifier
c0a6bc1 
This avoids type suffixes for integer constants when the type can be
inferred from the template parameter.

Closes root-project#18363

Co-authored-by: Philippe Canal <[email protected]>

(cherry picked from commit 982f5d7)
@hahnjo hahnjo mentioned this issue May 7, 2025
Merged
pcanal added a commit to root-project/roottest that referenced this issue May 7, 2025
@hahnjo @pcanal
Add roottest for name normalization issue
9cb7b32 
root-project/root#18363

Co-authored-by: Philippe Canal <[email protected]>
pcanal pushed a commit that referenced this issue May 7, 2025
@hahnjo @pcanal
[clang] Forward TPL of NestedNameSpecifier
e7e013c 
This avoids type suffixes for integer constants when the type can be
inferred from the template parameter.

Closes #18363

Co-authored-by: Philippe Canal <[email protected]>

(cherry picked from commit 982f5d7)
hahnjo added a commit to hahnjo/roottest that referenced this issue May 8, 2025
@hahnjo @pcanal
Add roottest for name normalization issue
bf771ec 
root-project/root#18363

Co-authored-by: Philippe Canal <[email protected]>
@hahnjo hahnjo mentioned this issue May 8, 2025
Merged
hahnjo added a commit to hahnjo/root that referenced this issue May 8, 2025
@hahnjo
[clang] Forward TPL of NestedNameSpecifier
474257c 
This avoids type suffixes for integer constants when the type can be
inferred from the template parameter.

Closes root-project#18363

Co-authored-by: Philippe Canal <[email protected]>

(cherry picked from commit 982f5d7)
@hahnjo hahnjo mentioned this issue May 8, 2025
Merged
hahnjo added a commit that referenced this issue May 9, 2025
@hahnjo
[clang] Forward TPL of NestedNameSpecifier
4467b69 
This avoids type suffixes for integer constants when the type can be
inferred from the template parameter.

Closes #18363

Co-authored-by: Philippe Canal <[email protected]>

(cherry picked from commit 982f5d7)
hahnjo added a commit to root-project/roottest that referenced this issue May 9, 2025
@hahnjo @pcanal
Add roottest for name normalization issue
70c38ed 
root-project/root#18363

Co-authored-by: Philippe Canal <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pcanal pcanal

Labels
bug experiment Affects an experiment / reported by its software & computimng experts in:Cling in:Core Libraries in:Dictionaries priority:critical
Projects
Fixed in 6.36.00
Status: No status
Fixed in 6.38.00
Status: No status
Milestone
6.36.00
2 participants
@pcanal and others