Resolving ILLink warnings on System.Private.Xml (Part 1) #49413

joperezr · 2021-03-10T03:58:37Z

Contributes to #45623

This is the first part of resolving the System.Private.Xml linker warnings, which for now involves most of the XslCompiledTransform ones.

ghost · 2021-03-10T03:58:43Z

Tagging subscribers to this area: @buyaa-n, @krwq
See info in area-owners.md if you want to be subscribed.

Issue Details

Contributes to #45623

cc: @eerhardt @krwq

This is the first part of resolving the System.Private.Xml linker warnings, which for now involves most of the non-serializer ones.

Author:	joperezr
Assignees:	-
Labels:	`area-System.Xml`
Milestone:	-

ghost · 2021-03-10T03:59:10Z

Tagging subscribers to 'linkable-framework': @eerhardt, @vitek-karas, @LakshanF, @tannergooding, @sbomer
See info in area-owners.md if you want to be subscribed.

Issue Details

Contributes to #45623

cc: @eerhardt @krwq

This is the first part of resolving the System.Private.Xml linker warnings, which for now involves most of the non-serializer ones.

Author:	joperezr
Assignees:	-
Labels:	`area-System.Xml`, `linkable-framework`
Milestone:	-

joperezr · 2021-03-10T04:01:05Z

Some of the annotations touch public API so I'll rerun genapi to have those annotations on the ref as well.

src/libraries/System.Private.Xml/src/System/Xml/Xsl/Xslt/QilGenerator.cs

src/libraries/System.Private.Xml/src/System/Xml/Xsl/Xslt/Scripts.cs

src/libraries/System.Private.Xml/src/System/Xml/Xslt/XslCompiledTransform.cs

…orm type

joperezr · 2021-03-11T23:59:52Z

This is almost ready for review, but I'm still addressing a couple of warnings still so hold off on reviewing for now

joperezr · 2021-03-12T23:58:51Z

This is now ready for review

eerhardt · 2021-03-13T04:03:31Z

src/libraries/System.Private.Xml/src/System/Xml/Xsl/Runtime/EarlyBoundInfo.cs

@@ -14,13 +15,16 @@ internal sealed class EarlyBoundInfo
    {
        private readonly string _namespaceUri;            // Namespace Uri mapped to these early bound functions
        private readonly ConstructorInfo _constrInfo;     // Constructor for the early bound function object
+        [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)]
+        private readonly Type _ebType;


(minor) I assume we don't need to worry about the size of these objects.

@krwq do you know if that's the case? Also, do you know if EarlyBoundInfos get used for anything other than Scripts in Xsls? Because if that's the case, we can potentially just remove this whole type as it would be currently just dead code.

src/libraries/System.Private.Xml/src/System/Xml/Xsl/Runtime/EarlyBoundInfo.cs

eerhardt · 2021-03-13T04:09:18Z

src/libraries/System.Private.Xml/src/System/Xml/Xsl/Xslt/QilGenerator.cs

            List<EarlyBoundInfo> ebTypes = new List<EarlyBoundInfo>(scriptClasses.Count);
-            foreach (KeyValuePair<string, Type?> pair in scriptClasses)
+            foreach (string key in scriptClasses.Keys)


Why the change here to enumerate the keys and then index into the dictionary? Why not just expose GetEnumerator from TrimSafeDictionary?

The problem here is that if we keep it as it was, then we would get a warning (even when using TrimmerSafeDictionary) since the Type would be comming form method: System.Collections.Generic.KeyValuePair<Tkey, TValue>.get which wouldn't be annotated. Of course we could suppress that, but by doing it the way I'm doing it here, the value gets accessed via the index operator on TrimmerSafeDictionary, so that way the linker will not throw a warning and we won't need an additional suppression.

eerhardt · 2021-03-13T04:10:07Z

src/libraries/System.Private.Xml/src/System/Xml/Xsl/Xslt/Scripts.cs

+                [UnconditionalSuppressMessage("TrimAnalysis", "IL2073:MissingDynamicallyAccessedMembers",
+                    Justification = "The getter of the dictionary is not annotated to preserve the constructor, but the sources that are adding the items to " +
+                    "the dictionary are annotated so we can supress the message as we know the constructor will be preserved.")]
+                [return: DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicParameterlessConstructor)]


Can we just put the attribute on the whole property?

Chatted offline, this is a problem specific to Indexers and have logged the following issue for investigation tracking: dotnet/linker#1902

eerhardt · 2021-03-13T04:10:54Z

src/libraries/System.Private.Xml/src/System/Xml/Xsl/XsltOld/Processor.cs

@@ -371,15 +371,10 @@ internal XsltOutput Output

            _scriptExtensions = new Hashtable(_stylesheet.ScriptObjectTypes.Count);
            {
-                foreach (DictionaryEntry entry in _stylesheet.ScriptObjectTypes)
+                // Scripts are not supported on stylesheets


Do we need a test for this or something? Are we concerned about the behavior change?

This is a functional change as far as I can tell - we should have the proper tests and get it reviewed by the area owners.

Agreed, @krwq AFAICT Script objects on xsls are not supported at all in .NET Core. I tried with several different approaches trying to create an xsl that had scripts and all entrypoints that I found trhough XslCompiledTransform would all eventually throw PNSE. I think that this has been dead code that we just originally imported from .NET Framework, but never really did anything as it throws PNSE when you actually invoke the transform operation.

IIRC that's correct and intentional. @joperezr you can double check by creating an xslt which works on full fx and make sure it throws on 5.0 - check for all types of scripts.

…rlyBoundInfo.cs Co-authored-by: Eric Erhardt <eric.erhardt@microsoft.com>

krwq · 2021-03-16T08:32:04Z

src/libraries/System.Private.Xml/src/System/Xml/Xsl/XsltOld/Processor.cs

@@ -371,15 +371,10 @@ internal XsltOutput Output

            _scriptExtensions = new Hashtable(_stylesheet.ScriptObjectTypes.Count);
            {
-                foreach (DictionaryEntry entry in _stylesheet.ScriptObjectTypes)
+                // Scripts are not supported on stylesheets
+                if (_stylesheet.ScriptObjectTypes.Count > 0)


might be a good idea to also simplify parsing this to save even more bytes

eerhardt · 2021-03-17T22:18:47Z

src/libraries/System.Private.Xml/src/System/Xml/Xslt/XslCompiledTransform.cs

@@ -238,6 +238,7 @@ public void Load(Type compiledStylesheet)
                throw new ArgumentException(SR.Format(SR.Xslt_NotCompiledStylesheet, compiledStylesheet.FullName), nameof(compiledStylesheet));
        }

+        [RequiresUnreferencedCode("This method will call into constructors of the earlyBoundTypes array which cannot be statically analized.")]


analized => analyzed repeated elsewhere.

eerhardt · 2021-03-17T22:22:57Z

src/libraries/System.Private.Xml/src/System/Xml/Xsl/XmlIlGenerator.cs

@@ -70,6 +70,10 @@ public XmlILGenerator()
        // SxS Note: The way the trace file names are created (hardcoded) is NOT SxS safe. However the files are
        // created only for internal tracing purposes. In addition XmlILTrace class is not compiled into retail
        // builds. As a result it is fine to suppress the FxCop SxS warning.
+        [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:MissingRequiresUnreferencedCode",


(nit) typically I've been using just IL2026:RequiresUnreferencedCode. The word after the number doesn't really matter to the trimmer. But warning IL2026 is because you are calling a method attributed with RequiresUnreferencedCode. So when you suppress the warning, you are suppressing the fact that you are calling a method with RequiresUnreferencedCode, not that RequiresUnreferencedCode is "missing".

eerhardt · 2021-03-17T22:23:11Z

src/libraries/System.Private.Xml/src/System/Xml/Xsl/XmlIlGenerator.cs

+        [UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:MissingRequiresUnreferencedCode",
+            Justification = "This method will generate the IL methods using RefEmit at runtime, which will then try to call them " +
+            "using methods that are annotated as RequiresUnreferencedCode. In this case, these uses can be suppressed as the " +
+            "linker won't be able to trim any IL that gets generated at runtime.")]


linker => trimmer #Resolved

eerhardt · 2021-03-17T22:24:34Z

src/libraries/System.Private.Xml/src/System/Xml/Xsl/XsltOld/Processor.cs

-                    }
-                    _scriptExtensions.Add(namespaceUri, Activator.CreateInstance((Type)entry.Value!,
-                        BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic, null, null, null));
+                    throw new PlatformNotSupportedException(SR.CompilingScriptsNotSupported);


Is it worth/possible to add a test here? I'm not asking for a bunch of work, but if it is reasonable (say an hour) it might be nice to ensure this scenario throws PNSE correctly. #Resolved

Sure, I can add a unit test for this. This is actually addressing a warning on the old xslt which is not currently covered by this PR (except for this one) but I can add a test here that ensures that using scripts on old xslt throws PNSE at the compile stage which is earlier than this code comes into play. #Resolved

eerhardt · 2021-03-17T22:27:03Z

src/libraries/System.Private.Xml/src/System/Xml/Xsl/Xslt/Scripts.cs

+
+            public ICollection<string> Keys => ((IDictionary<string, Type?>)_backingDictionary).Keys;
+
+            public int Count => ((ICollection<KeyValuePair<string, Type?>>)_backingDictionary).Count;


Why are all these casts of _backingDictionary necessary? Can't you just return _backingDictionary.Count? #Resolved

I'll fix it, not necessary, I just used the quick refactoring ctrl+'.' options in VS that added the casts:

#Resolved

eerhardt

Looks good. Thanks @joperezr!

Resolving ILLink warnings on System.Private.Xml (Part 1)

538bb29

dotnet-issue-labeler bot added the area-System.Xml label Mar 10, 2021

joperezr requested review from eerhardt and krwq and removed request for eerhardt March 10, 2021 03:58

joperezr added the linkable-framework Issues associated with delivering a linker friendly framework label Mar 10, 2021

vitek-karas reviewed Mar 10, 2021

View reviewed changes

src/libraries/System.Private.Xml/src/System/Xml/Xsl/Xslt/QilGenerator.cs Outdated Show resolved Hide resolved

vitek-karas reviewed Mar 10, 2021

View reviewed changes

src/libraries/System.Private.Xml/src/System/Xml/Xsl/Xslt/Scripts.cs Outdated Show resolved Hide resolved

vitek-karas reviewed Mar 10, 2021

View reviewed changes

src/libraries/System.Private.Xml/src/System/Xml/Xslt/XslCompiledTransform.cs Outdated Show resolved Hide resolved

Only annotate the unsafe Load overload methods from XslCompiledTransf…

f688780

…orm type

runfoapp bot mentioned this pull request Mar 12, 2021

Checkout bundle fails to upload/download #45872

Closed

Address feedback and fix one more warning

7cbd958

eerhardt reviewed Mar 13, 2021

View reviewed changes

src/libraries/System.Private.Xml/src/System/Xml/Xsl/Runtime/EarlyBoundInfo.cs Outdated Show resolved Hide resolved

eerhardt reviewed Mar 13, 2021

View reviewed changes

Update src/libraries/System.Private.Xml/src/System/Xml/Xsl/Runtime/Ea…

8b57fe5

…rlyBoundInfo.cs Co-authored-by: Eric Erhardt <eric.erhardt@microsoft.com>

krwq reviewed Mar 16, 2021

View reviewed changes

runfoapp bot mentioned this pull request Mar 16, 2021

Mono System.Text.Json.Tests on Windows timing out #42677

Open

joperezr mentioned this pull request Mar 16, 2021

Annotating property indexers causes the linker to treat the key (index) to have the annotations too. dotnet/linker#1902

Closed

eerhardt reviewed Mar 17, 2021

View reviewed changes

PR Feedback

6656141

eerhardt approved these changes Mar 18, 2021

View reviewed changes

joperezr merged commit fbb6a1c into dotnet:main Mar 19, 2021

joperezr deleted the LinkerXml branch March 19, 2021 16:51

runfoapp bot mentioned this pull request Mar 22, 2021

Test failure Wasm.Build.Tests.WasmBuildAppTest.InvariantGlobalization #49494

Closed

ghost locked as resolved and limited conversation to collaborators Apr 18, 2021

karelz added this to the 6.0.0 milestone May 20, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Resolving ILLink warnings on System.Private.Xml (Part 1) #49413

Resolving ILLink warnings on System.Private.Xml (Part 1) #49413

joperezr commented Mar 10, 2021 •

edited

Loading

ghost commented Mar 10, 2021 •

edited by joperezr

Loading

ghost commented Mar 10, 2021 •

edited by joperezr

Loading

joperezr commented Mar 10, 2021 •

edited

Loading

joperezr commented Mar 11, 2021 •

edited

Loading

joperezr commented Mar 12, 2021

eerhardt Mar 13, 2021

joperezr Mar 15, 2021

eerhardt Mar 13, 2021

joperezr Mar 15, 2021

eerhardt Mar 13, 2021

joperezr Mar 16, 2021

eerhardt Mar 13, 2021

vitek-karas Mar 15, 2021

joperezr Mar 15, 2021

krwq Mar 16, 2021 •

edited

Loading

krwq Mar 16, 2021

eerhardt Mar 17, 2021 •

edited by joperezr

Loading

eerhardt Mar 17, 2021 •

edited by joperezr

Loading

eerhardt Mar 17, 2021 •

edited by joperezr

Loading

eerhardt Mar 17, 2021 •

edited by joperezr

Loading

joperezr Mar 18, 2021 •

edited

Loading

eerhardt Mar 17, 2021 •

edited by joperezr

Loading

joperezr Mar 18, 2021 •

edited

Loading

eerhardt left a comment


		public ICollection<string> Keys => ((IDictionary<string, Type?>)_backingDictionary).Keys;

		public int Count => ((ICollection<KeyValuePair<string, Type?>>)_backingDictionary).Count;

Resolving ILLink warnings on System.Private.Xml (Part 1) #49413

Resolving ILLink warnings on System.Private.Xml (Part 1) #49413

Conversation

joperezr commented Mar 10, 2021 • edited Loading

ghost commented Mar 10, 2021 • edited by joperezr Loading

ghost commented Mar 10, 2021 • edited by joperezr Loading

joperezr commented Mar 10, 2021 • edited Loading

joperezr commented Mar 11, 2021 • edited Loading

joperezr commented Mar 12, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

krwq Mar 16, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eerhardt Mar 17, 2021 • edited by joperezr Loading

Choose a reason for hiding this comment

eerhardt Mar 17, 2021 • edited by joperezr Loading

Choose a reason for hiding this comment

eerhardt Mar 17, 2021 • edited by joperezr Loading

Choose a reason for hiding this comment

eerhardt Mar 17, 2021 • edited by joperezr Loading

Choose a reason for hiding this comment

joperezr Mar 18, 2021 • edited Loading

Choose a reason for hiding this comment

eerhardt Mar 17, 2021 • edited by joperezr Loading

Choose a reason for hiding this comment

joperezr Mar 18, 2021 • edited Loading

Choose a reason for hiding this comment

eerhardt left a comment

Choose a reason for hiding this comment

joperezr commented Mar 10, 2021 •

edited

Loading

ghost commented Mar 10, 2021 •

edited by joperezr

Loading

ghost commented Mar 10, 2021 •

edited by joperezr

Loading

joperezr commented Mar 10, 2021 •

edited

Loading

joperezr commented Mar 11, 2021 •

edited

Loading

krwq Mar 16, 2021 •

edited

Loading

eerhardt Mar 17, 2021 •

edited by joperezr

Loading

eerhardt Mar 17, 2021 •

edited by joperezr

Loading

eerhardt Mar 17, 2021 •

edited by joperezr

Loading

eerhardt Mar 17, 2021 •

edited by joperezr

Loading

joperezr Mar 18, 2021 •

edited

Loading

eerhardt Mar 17, 2021 •

edited by joperezr

Loading

joperezr Mar 18, 2021 •

edited

Loading