[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile - #91520

Merged
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning
Sep 8, 2023
Merged

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile#91520
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning

Conversation

@simonrozsival

@simonrozsivalsimonrozsival commented Sep 3, 2023

Copy link
Copy Markdown
Member

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

This PR fixes the warning.

@ghost

ghost commented Sep 3, 2023

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:-
Labels:

area-System.Net.Http, os-ios

Milestone:-

@simonrozsival

This comment was marked as outdated.

@azure-pipelines

This comment was marked as outdated.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-extra-platforms

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky added the linkable-framework Issues associated with delivering a linker friendly framework label Sep 7, 2023
@ghost

ghost commented Sep 7, 2023

Copy link
Copy Markdown

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

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:simonrozsival
Labels:

area-System.Net.Http, linkable-framework, os-ios

Milestone:-

@MichalStrehovsky

Copy link
Copy Markdown
Member

We typically write targeted trimming tests if there is a suppression. Suppressions are not great because someone could add a new callsite and forget to add DynamicDependency (or DynamicDependency the wrong thing).

I think this can be rewritten to be correct by construction. All the text strings are there, they're just too far apart for analysis to figure them out.

Basically, I'd do this:

  • Delete all the DynamicDependency stuff.
  • Replace _nativeHandler!.GetType()!.GetMethod(name); in InvokeNativeHandlerMethod with Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name);. The C# compiler will concatenate these strings because they're all consts.
  • This is already enough to make everything work. Trimming will keep all public methods on the type and there will be no warning. This is because the name of the type is visible within the InvokeNativeHandlerMethod method.
  • If there is a size concern (we don't want to keep all the public methods on this type), we could hoist the Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name); part into a delegate (add an Action<MethodInfo> delegate parameter to InvokeNativeHandlerMethod and provide the right implementation at each callsite as a lambda). This should result in comparable size to what was achieved with DynamicDependency (the attributes are not cheap, size-wise - it's a lot of characters and none of them can be shared even though they're identical because custom attributes are encoded that way).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@MichalStrehovsky thanks for the suggestion!

@simonrozsival
simonrozsival marked this pull request as draft September 7, 2023 13:46
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! (Reviewing from the trimmability perspective only.)

Cc @AaronRobinsonMSFT - I think this is a nice candidate for #90081. We'll be able to simplify all of this and get rid of the reflection.

@simonrozsivalsimonrozsival changed the title [iOS] Unconditionally suppress trimming warnings in HttpClientHandler[iOS] Fix trimming warnings in HttpClientHandler.AnyMobileSep 8, 2023
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-android

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival
simonrozsival merged commit 7f06d1c into dotnet:mainSep 8, 2023
@simonrozsival
simonrozsival deleted the http-client-handler-anymobile-suppress-ilc-warning branch September 8, 2023 19:07
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0-rc1

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0-rc1: https://github.com/dotnet/runtime/actions/runs/6130417198

@stephentoub

Copy link
Copy Markdown
Member

Was release/8.0-rc1 correct or should it have been release/8.0 instead?

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@stephentoub you're right, it shouldn't be RC1. I'll open a new backport.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0: https://github.com/dotnet/runtime/actions/runs/6145796878

InvokeNativeHandlerMethod(getMethod, parameters: new object?[] { value }, cachingKey!);
}

private object InvokeNativeHandlerMethod(Func<MethodInfo> getMethod, object?[]? parameters, string cachingKey)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it not static?


private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)
{
return InvokeNativeHandlerMethod(getMethod, parameters: null, cachingKey!);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add Debug.Assert instead of only !

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps Type.GetType(NativeHandlerType) could come as an argument to the lambda and you could cache it too.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I understand it, by keeping the GetType and GetMethod calls together with constant arguments will give the trimmer enough information to keep only the methods that are actually used. If we cached the type, I think it wouldn't be trimmable anymore.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true. We don't have a way to do this with caching the Type (without suppressing some warnings).
Once we have UnsafeAccessorType then this can be rewritten to use that and it will not use any reflection and be faster.

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the lambdas should be static (not sure why the analyzer does not complain).

return (HttpMessageHandler)_nativeHandlerMethod!.Invoke(null, null)!;
}

private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could use CallerLineNumberAttribute or some other key which is not a next string in the assembly

@karelzkarelz added this to the 9.0.0 milestone Sep 14, 2023
@ghostghost locked as resolved and limited conversation to collaborators Oct 14, 2023
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Net.Httplinkable-frameworkIssues associated with delivering a linker friendly frameworkos-iosApple iOS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@simonrozsival@MichalStrehovsky@stephentoub@marek-safar@akoeplinger@eerhardt@vitek-karas@karelz
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile - #91520

Merged
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning
Sep 8, 2023
Merged

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile#91520
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning

Conversation

@simonrozsival

@simonrozsivalsimonrozsival commented Sep 3, 2023

Copy link
Copy Markdown
Member

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

This PR fixes the warning.

@ghost

ghost commented Sep 3, 2023

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:-
Labels:

area-System.Net.Http, os-ios

Milestone:-

@simonrozsival

This comment was marked as outdated.

@azure-pipelines

This comment was marked as outdated.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-extra-platforms

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky added the linkable-framework Issues associated with delivering a linker friendly framework label Sep 7, 2023
@ghost

ghost commented Sep 7, 2023

Copy link
Copy Markdown

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

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:simonrozsival
Labels:

area-System.Net.Http, linkable-framework, os-ios

Milestone:-

@MichalStrehovsky

Copy link
Copy Markdown
Member

We typically write targeted trimming tests if there is a suppression. Suppressions are not great because someone could add a new callsite and forget to add DynamicDependency (or DynamicDependency the wrong thing).

I think this can be rewritten to be correct by construction. All the text strings are there, they're just too far apart for analysis to figure them out.

Basically, I'd do this:

  • Delete all the DynamicDependency stuff.
  • Replace _nativeHandler!.GetType()!.GetMethod(name); in InvokeNativeHandlerMethod with Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name);. The C# compiler will concatenate these strings because they're all consts.
  • This is already enough to make everything work. Trimming will keep all public methods on the type and there will be no warning. This is because the name of the type is visible within the InvokeNativeHandlerMethod method.
  • If there is a size concern (we don't want to keep all the public methods on this type), we could hoist the Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name); part into a delegate (add an Action<MethodInfo> delegate parameter to InvokeNativeHandlerMethod and provide the right implementation at each callsite as a lambda). This should result in comparable size to what was achieved with DynamicDependency (the attributes are not cheap, size-wise - it's a lot of characters and none of them can be shared even though they're identical because custom attributes are encoded that way).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@MichalStrehovsky thanks for the suggestion!

@simonrozsival
simonrozsival marked this pull request as draft September 7, 2023 13:46
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! (Reviewing from the trimmability perspective only.)

Cc @AaronRobinsonMSFT - I think this is a nice candidate for #90081. We'll be able to simplify all of this and get rid of the reflection.

@simonrozsivalsimonrozsival changed the title [iOS] Unconditionally suppress trimming warnings in HttpClientHandler[iOS] Fix trimming warnings in HttpClientHandler.AnyMobileSep 8, 2023
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-android

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival
simonrozsival merged commit 7f06d1c into dotnet:mainSep 8, 2023
@simonrozsival
simonrozsival deleted the http-client-handler-anymobile-suppress-ilc-warning branch September 8, 2023 19:07
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0-rc1

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0-rc1: https://github.com/dotnet/runtime/actions/runs/6130417198

@stephentoub

Copy link
Copy Markdown
Member

Was release/8.0-rc1 correct or should it have been release/8.0 instead?

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@stephentoub you're right, it shouldn't be RC1. I'll open a new backport.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0: https://github.com/dotnet/runtime/actions/runs/6145796878

InvokeNativeHandlerMethod(getMethod, parameters: new object?[] { value }, cachingKey!);
}

private object InvokeNativeHandlerMethod(Func<MethodInfo> getMethod, object?[]? parameters, string cachingKey)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it not static?


private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)
{
return InvokeNativeHandlerMethod(getMethod, parameters: null, cachingKey!);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add Debug.Assert instead of only !

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps Type.GetType(NativeHandlerType) could come as an argument to the lambda and you could cache it too.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I understand it, by keeping the GetType and GetMethod calls together with constant arguments will give the trimmer enough information to keep only the methods that are actually used. If we cached the type, I think it wouldn't be trimmable anymore.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true. We don't have a way to do this with caching the Type (without suppressing some warnings).
Once we have UnsafeAccessorType then this can be rewritten to use that and it will not use any reflection and be faster.

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the lambdas should be static (not sure why the analyzer does not complain).

return (HttpMessageHandler)_nativeHandlerMethod!.Invoke(null, null)!;
}

private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could use CallerLineNumberAttribute or some other key which is not a next string in the assembly

@karelzkarelz added this to the 9.0.0 milestone Sep 14, 2023
@ghostghost locked as resolved and limited conversation to collaborators Oct 14, 2023
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Net.Httplinkable-frameworkIssues associated with delivering a linker friendly frameworkos-iosApple iOS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@simonrozsival@MichalStrehovsky@stephentoub@marek-safar@akoeplinger@eerhardt@vitek-karas@karelz
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile - #91520

Merged
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning
Sep 8, 2023
Merged

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile#91520
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning

Conversation

@simonrozsival

@simonrozsivalsimonrozsival commented Sep 3, 2023

Copy link
Copy Markdown
Member

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

This PR fixes the warning.

@ghost

ghost commented Sep 3, 2023

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:-
Labels:

area-System.Net.Http, os-ios

Milestone:-

@simonrozsival

This comment was marked as outdated.

@azure-pipelines

This comment was marked as outdated.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-extra-platforms

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky added the linkable-framework Issues associated with delivering a linker friendly framework label Sep 7, 2023
@ghost

ghost commented Sep 7, 2023

Copy link
Copy Markdown

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

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:simonrozsival
Labels:

area-System.Net.Http, linkable-framework, os-ios

Milestone:-

@MichalStrehovsky

Copy link
Copy Markdown
Member

We typically write targeted trimming tests if there is a suppression. Suppressions are not great because someone could add a new callsite and forget to add DynamicDependency (or DynamicDependency the wrong thing).

I think this can be rewritten to be correct by construction. All the text strings are there, they're just too far apart for analysis to figure them out.

Basically, I'd do this:

  • Delete all the DynamicDependency stuff.
  • Replace _nativeHandler!.GetType()!.GetMethod(name); in InvokeNativeHandlerMethod with Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name);. The C# compiler will concatenate these strings because they're all consts.
  • This is already enough to make everything work. Trimming will keep all public methods on the type and there will be no warning. This is because the name of the type is visible within the InvokeNativeHandlerMethod method.
  • If there is a size concern (we don't want to keep all the public methods on this type), we could hoist the Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name); part into a delegate (add an Action<MethodInfo> delegate parameter to InvokeNativeHandlerMethod and provide the right implementation at each callsite as a lambda). This should result in comparable size to what was achieved with DynamicDependency (the attributes are not cheap, size-wise - it's a lot of characters and none of them can be shared even though they're identical because custom attributes are encoded that way).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@MichalStrehovsky thanks for the suggestion!

@simonrozsival
simonrozsival marked this pull request as draft September 7, 2023 13:46
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! (Reviewing from the trimmability perspective only.)

Cc @AaronRobinsonMSFT - I think this is a nice candidate for #90081. We'll be able to simplify all of this and get rid of the reflection.

@simonrozsivalsimonrozsival changed the title [iOS] Unconditionally suppress trimming warnings in HttpClientHandler[iOS] Fix trimming warnings in HttpClientHandler.AnyMobileSep 8, 2023
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-android

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival
simonrozsival merged commit 7f06d1c into dotnet:mainSep 8, 2023
@simonrozsival
simonrozsival deleted the http-client-handler-anymobile-suppress-ilc-warning branch September 8, 2023 19:07
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0-rc1

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0-rc1: https://github.com/dotnet/runtime/actions/runs/6130417198

@stephentoub

Copy link
Copy Markdown
Member

Was release/8.0-rc1 correct or should it have been release/8.0 instead?

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@stephentoub you're right, it shouldn't be RC1. I'll open a new backport.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0: https://github.com/dotnet/runtime/actions/runs/6145796878

InvokeNativeHandlerMethod(getMethod, parameters: new object?[] { value }, cachingKey!);
}

private object InvokeNativeHandlerMethod(Func<MethodInfo> getMethod, object?[]? parameters, string cachingKey)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it not static?


private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)
{
return InvokeNativeHandlerMethod(getMethod, parameters: null, cachingKey!);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add Debug.Assert instead of only !

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps Type.GetType(NativeHandlerType) could come as an argument to the lambda and you could cache it too.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I understand it, by keeping the GetType and GetMethod calls together with constant arguments will give the trimmer enough information to keep only the methods that are actually used. If we cached the type, I think it wouldn't be trimmable anymore.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true. We don't have a way to do this with caching the Type (without suppressing some warnings).
Once we have UnsafeAccessorType then this can be rewritten to use that and it will not use any reflection and be faster.

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the lambdas should be static (not sure why the analyzer does not complain).

return (HttpMessageHandler)_nativeHandlerMethod!.Invoke(null, null)!;
}

private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could use CallerLineNumberAttribute or some other key which is not a next string in the assembly

@karelzkarelz added this to the 9.0.0 milestone Sep 14, 2023
@ghostghost locked as resolved and limited conversation to collaborators Oct 14, 2023
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Net.Httplinkable-frameworkIssues associated with delivering a linker friendly frameworkos-iosApple iOS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@simonrozsival@MichalStrehovsky@stephentoub@marek-safar@akoeplinger@eerhardt@vitek-karas@karelz
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile - #91520

Merged
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning
Sep 8, 2023
Merged

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile#91520
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning

Conversation

@simonrozsival

@simonrozsivalsimonrozsival commented Sep 3, 2023

Copy link
Copy Markdown
Member

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

This PR fixes the warning.

@ghost

ghost commented Sep 3, 2023

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:-
Labels:

area-System.Net.Http, os-ios

Milestone:-

@simonrozsival

This comment was marked as outdated.

@azure-pipelines

This comment was marked as outdated.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-extra-platforms

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky added the linkable-framework Issues associated with delivering a linker friendly framework label Sep 7, 2023
@ghost

ghost commented Sep 7, 2023

Copy link
Copy Markdown

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

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:simonrozsival
Labels:

area-System.Net.Http, linkable-framework, os-ios

Milestone:-

@MichalStrehovsky

Copy link
Copy Markdown
Member

We typically write targeted trimming tests if there is a suppression. Suppressions are not great because someone could add a new callsite and forget to add DynamicDependency (or DynamicDependency the wrong thing).

I think this can be rewritten to be correct by construction. All the text strings are there, they're just too far apart for analysis to figure them out.

Basically, I'd do this:

  • Delete all the DynamicDependency stuff.
  • Replace _nativeHandler!.GetType()!.GetMethod(name); in InvokeNativeHandlerMethod with Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name);. The C# compiler will concatenate these strings because they're all consts.
  • This is already enough to make everything work. Trimming will keep all public methods on the type and there will be no warning. This is because the name of the type is visible within the InvokeNativeHandlerMethod method.
  • If there is a size concern (we don't want to keep all the public methods on this type), we could hoist the Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name); part into a delegate (add an Action<MethodInfo> delegate parameter to InvokeNativeHandlerMethod and provide the right implementation at each callsite as a lambda). This should result in comparable size to what was achieved with DynamicDependency (the attributes are not cheap, size-wise - it's a lot of characters and none of them can be shared even though they're identical because custom attributes are encoded that way).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@MichalStrehovsky thanks for the suggestion!

@simonrozsival
simonrozsival marked this pull request as draft September 7, 2023 13:46
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! (Reviewing from the trimmability perspective only.)

Cc @AaronRobinsonMSFT - I think this is a nice candidate for #90081. We'll be able to simplify all of this and get rid of the reflection.

@simonrozsivalsimonrozsival changed the title [iOS] Unconditionally suppress trimming warnings in HttpClientHandler[iOS] Fix trimming warnings in HttpClientHandler.AnyMobileSep 8, 2023
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-android

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival
simonrozsival merged commit 7f06d1c into dotnet:mainSep 8, 2023
@simonrozsival
simonrozsival deleted the http-client-handler-anymobile-suppress-ilc-warning branch September 8, 2023 19:07
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0-rc1

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0-rc1: https://github.com/dotnet/runtime/actions/runs/6130417198

@stephentoub

Copy link
Copy Markdown
Member

Was release/8.0-rc1 correct or should it have been release/8.0 instead?

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@stephentoub you're right, it shouldn't be RC1. I'll open a new backport.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0: https://github.com/dotnet/runtime/actions/runs/6145796878

InvokeNativeHandlerMethod(getMethod, parameters: new object?[] { value }, cachingKey!);
}

private object InvokeNativeHandlerMethod(Func<MethodInfo> getMethod, object?[]? parameters, string cachingKey)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it not static?


private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)
{
return InvokeNativeHandlerMethod(getMethod, parameters: null, cachingKey!);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add Debug.Assert instead of only !

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps Type.GetType(NativeHandlerType) could come as an argument to the lambda and you could cache it too.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I understand it, by keeping the GetType and GetMethod calls together with constant arguments will give the trimmer enough information to keep only the methods that are actually used. If we cached the type, I think it wouldn't be trimmable anymore.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true. We don't have a way to do this with caching the Type (without suppressing some warnings).
Once we have UnsafeAccessorType then this can be rewritten to use that and it will not use any reflection and be faster.

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the lambdas should be static (not sure why the analyzer does not complain).

return (HttpMessageHandler)_nativeHandlerMethod!.Invoke(null, null)!;
}

private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could use CallerLineNumberAttribute or some other key which is not a next string in the assembly

@karelzkarelz added this to the 9.0.0 milestone Sep 14, 2023
@ghostghost locked as resolved and limited conversation to collaborators Oct 14, 2023
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Net.Httplinkable-frameworkIssues associated with delivering a linker friendly frameworkos-iosApple iOS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@simonrozsival@MichalStrehovsky@stephentoub@marek-safar@akoeplinger@eerhardt@vitek-karas@karelz
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile - #91520

Merged
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning
Sep 8, 2023
Merged

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile#91520
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning

Conversation

@simonrozsival

@simonrozsivalsimonrozsival commented Sep 3, 2023

Copy link
Copy Markdown
Member

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

This PR fixes the warning.

@ghost

ghost commented Sep 3, 2023

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:-
Labels:

area-System.Net.Http, os-ios

Milestone:-

@simonrozsival

This comment was marked as outdated.

@azure-pipelines

This comment was marked as outdated.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-extra-platforms

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky added the linkable-framework Issues associated with delivering a linker friendly framework label Sep 7, 2023
@ghost

ghost commented Sep 7, 2023

Copy link
Copy Markdown

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

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:simonrozsival
Labels:

area-System.Net.Http, linkable-framework, os-ios

Milestone:-

@MichalStrehovsky

Copy link
Copy Markdown
Member

We typically write targeted trimming tests if there is a suppression. Suppressions are not great because someone could add a new callsite and forget to add DynamicDependency (or DynamicDependency the wrong thing).

I think this can be rewritten to be correct by construction. All the text strings are there, they're just too far apart for analysis to figure them out.

Basically, I'd do this:

  • Delete all the DynamicDependency stuff.
  • Replace _nativeHandler!.GetType()!.GetMethod(name); in InvokeNativeHandlerMethod with Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name);. The C# compiler will concatenate these strings because they're all consts.
  • This is already enough to make everything work. Trimming will keep all public methods on the type and there will be no warning. This is because the name of the type is visible within the InvokeNativeHandlerMethod method.
  • If there is a size concern (we don't want to keep all the public methods on this type), we could hoist the Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name); part into a delegate (add an Action<MethodInfo> delegate parameter to InvokeNativeHandlerMethod and provide the right implementation at each callsite as a lambda). This should result in comparable size to what was achieved with DynamicDependency (the attributes are not cheap, size-wise - it's a lot of characters and none of them can be shared even though they're identical because custom attributes are encoded that way).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@MichalStrehovsky thanks for the suggestion!

@simonrozsival
simonrozsival marked this pull request as draft September 7, 2023 13:46
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! (Reviewing from the trimmability perspective only.)

Cc @AaronRobinsonMSFT - I think this is a nice candidate for #90081. We'll be able to simplify all of this and get rid of the reflection.

@simonrozsivalsimonrozsival changed the title [iOS] Unconditionally suppress trimming warnings in HttpClientHandler[iOS] Fix trimming warnings in HttpClientHandler.AnyMobileSep 8, 2023
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-android

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival
simonrozsival merged commit 7f06d1c into dotnet:mainSep 8, 2023
@simonrozsival
simonrozsival deleted the http-client-handler-anymobile-suppress-ilc-warning branch September 8, 2023 19:07
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0-rc1

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0-rc1: https://github.com/dotnet/runtime/actions/runs/6130417198

@stephentoub

Copy link
Copy Markdown
Member

Was release/8.0-rc1 correct or should it have been release/8.0 instead?

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@stephentoub you're right, it shouldn't be RC1. I'll open a new backport.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0: https://github.com/dotnet/runtime/actions/runs/6145796878

InvokeNativeHandlerMethod(getMethod, parameters: new object?[] { value }, cachingKey!);
}

private object InvokeNativeHandlerMethod(Func<MethodInfo> getMethod, object?[]? parameters, string cachingKey)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it not static?


private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)
{
return InvokeNativeHandlerMethod(getMethod, parameters: null, cachingKey!);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add Debug.Assert instead of only !

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps Type.GetType(NativeHandlerType) could come as an argument to the lambda and you could cache it too.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I understand it, by keeping the GetType and GetMethod calls together with constant arguments will give the trimmer enough information to keep only the methods that are actually used. If we cached the type, I think it wouldn't be trimmable anymore.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true. We don't have a way to do this with caching the Type (without suppressing some warnings).
Once we have UnsafeAccessorType then this can be rewritten to use that and it will not use any reflection and be faster.

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the lambdas should be static (not sure why the analyzer does not complain).

return (HttpMessageHandler)_nativeHandlerMethod!.Invoke(null, null)!;
}

private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could use CallerLineNumberAttribute or some other key which is not a next string in the assembly

@karelzkarelz added this to the 9.0.0 milestone Sep 14, 2023
@ghostghost locked as resolved and limited conversation to collaborators Oct 14, 2023
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Net.Httplinkable-frameworkIssues associated with delivering a linker friendly frameworkos-iosApple iOS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@simonrozsival@MichalStrehovsky@stephentoub@marek-safar@akoeplinger@eerhardt@vitek-karas@karelz
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile - #91520

Merged
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning
Sep 8, 2023
Merged

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile#91520
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning

Conversation

@simonrozsival

@simonrozsivalsimonrozsival commented Sep 3, 2023

Copy link
Copy Markdown
Member

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

This PR fixes the warning.

@ghost

ghost commented Sep 3, 2023

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:-
Labels:

area-System.Net.Http, os-ios

Milestone:-

@simonrozsival

This comment was marked as outdated.

@azure-pipelines

This comment was marked as outdated.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-extra-platforms

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky added the linkable-framework Issues associated with delivering a linker friendly framework label Sep 7, 2023
@ghost

ghost commented Sep 7, 2023

Copy link
Copy Markdown

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

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:simonrozsival
Labels:

area-System.Net.Http, linkable-framework, os-ios

Milestone:-

@MichalStrehovsky

Copy link
Copy Markdown
Member

We typically write targeted trimming tests if there is a suppression. Suppressions are not great because someone could add a new callsite and forget to add DynamicDependency (or DynamicDependency the wrong thing).

I think this can be rewritten to be correct by construction. All the text strings are there, they're just too far apart for analysis to figure them out.

Basically, I'd do this:

  • Delete all the DynamicDependency stuff.
  • Replace _nativeHandler!.GetType()!.GetMethod(name); in InvokeNativeHandlerMethod with Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name);. The C# compiler will concatenate these strings because they're all consts.
  • This is already enough to make everything work. Trimming will keep all public methods on the type and there will be no warning. This is because the name of the type is visible within the InvokeNativeHandlerMethod method.
  • If there is a size concern (we don't want to keep all the public methods on this type), we could hoist the Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name); part into a delegate (add an Action<MethodInfo> delegate parameter to InvokeNativeHandlerMethod and provide the right implementation at each callsite as a lambda). This should result in comparable size to what was achieved with DynamicDependency (the attributes are not cheap, size-wise - it's a lot of characters and none of them can be shared even though they're identical because custom attributes are encoded that way).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@MichalStrehovsky thanks for the suggestion!

@simonrozsival
simonrozsival marked this pull request as draft September 7, 2023 13:46
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! (Reviewing from the trimmability perspective only.)

Cc @AaronRobinsonMSFT - I think this is a nice candidate for #90081. We'll be able to simplify all of this and get rid of the reflection.

@simonrozsivalsimonrozsival changed the title [iOS] Unconditionally suppress trimming warnings in HttpClientHandler[iOS] Fix trimming warnings in HttpClientHandler.AnyMobileSep 8, 2023
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-android

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival
simonrozsival merged commit 7f06d1c into dotnet:mainSep 8, 2023
@simonrozsival
simonrozsival deleted the http-client-handler-anymobile-suppress-ilc-warning branch September 8, 2023 19:07
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0-rc1

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0-rc1: https://github.com/dotnet/runtime/actions/runs/6130417198

@stephentoub

Copy link
Copy Markdown
Member

Was release/8.0-rc1 correct or should it have been release/8.0 instead?

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@stephentoub you're right, it shouldn't be RC1. I'll open a new backport.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0: https://github.com/dotnet/runtime/actions/runs/6145796878

InvokeNativeHandlerMethod(getMethod, parameters: new object?[] { value }, cachingKey!);
}

private object InvokeNativeHandlerMethod(Func<MethodInfo> getMethod, object?[]? parameters, string cachingKey)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it not static?


private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)
{
return InvokeNativeHandlerMethod(getMethod, parameters: null, cachingKey!);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add Debug.Assert instead of only !

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps Type.GetType(NativeHandlerType) could come as an argument to the lambda and you could cache it too.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I understand it, by keeping the GetType and GetMethod calls together with constant arguments will give the trimmer enough information to keep only the methods that are actually used. If we cached the type, I think it wouldn't be trimmable anymore.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true. We don't have a way to do this with caching the Type (without suppressing some warnings).
Once we have UnsafeAccessorType then this can be rewritten to use that and it will not use any reflection and be faster.

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the lambdas should be static (not sure why the analyzer does not complain).

return (HttpMessageHandler)_nativeHandlerMethod!.Invoke(null, null)!;
}

private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could use CallerLineNumberAttribute or some other key which is not a next string in the assembly

@karelzkarelz added this to the 9.0.0 milestone Sep 14, 2023
@ghostghost locked as resolved and limited conversation to collaborators Oct 14, 2023
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Net.Httplinkable-frameworkIssues associated with delivering a linker friendly frameworkos-iosApple iOS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@simonrozsival@MichalStrehovsky@stephentoub@marek-safar@akoeplinger@eerhardt@vitek-karas@karelz
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile - #91520

Merged
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning
Sep 8, 2023
Merged

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile#91520
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning

Conversation

@simonrozsival

@simonrozsivalsimonrozsival commented Sep 3, 2023

Copy link
Copy Markdown
Member

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

This PR fixes the warning.

@ghost

ghost commented Sep 3, 2023

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:-
Labels:

area-System.Net.Http, os-ios

Milestone:-

@simonrozsival

This comment was marked as outdated.

@azure-pipelines

This comment was marked as outdated.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-extra-platforms

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky added the linkable-framework Issues associated with delivering a linker friendly framework label Sep 7, 2023
@ghost

ghost commented Sep 7, 2023

Copy link
Copy Markdown

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

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:simonrozsival
Labels:

area-System.Net.Http, linkable-framework, os-ios

Milestone:-

@MichalStrehovsky

Copy link
Copy Markdown
Member

We typically write targeted trimming tests if there is a suppression. Suppressions are not great because someone could add a new callsite and forget to add DynamicDependency (or DynamicDependency the wrong thing).

I think this can be rewritten to be correct by construction. All the text strings are there, they're just too far apart for analysis to figure them out.

Basically, I'd do this:

  • Delete all the DynamicDependency stuff.
  • Replace _nativeHandler!.GetType()!.GetMethod(name); in InvokeNativeHandlerMethod with Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name);. The C# compiler will concatenate these strings because they're all consts.
  • This is already enough to make everything work. Trimming will keep all public methods on the type and there will be no warning. This is because the name of the type is visible within the InvokeNativeHandlerMethod method.
  • If there is a size concern (we don't want to keep all the public methods on this type), we could hoist the Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name); part into a delegate (add an Action<MethodInfo> delegate parameter to InvokeNativeHandlerMethod and provide the right implementation at each callsite as a lambda). This should result in comparable size to what was achieved with DynamicDependency (the attributes are not cheap, size-wise - it's a lot of characters and none of them can be shared even though they're identical because custom attributes are encoded that way).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@MichalStrehovsky thanks for the suggestion!

@simonrozsival
simonrozsival marked this pull request as draft September 7, 2023 13:46
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! (Reviewing from the trimmability perspective only.)

Cc @AaronRobinsonMSFT - I think this is a nice candidate for #90081. We'll be able to simplify all of this and get rid of the reflection.

@simonrozsivalsimonrozsival changed the title [iOS] Unconditionally suppress trimming warnings in HttpClientHandler[iOS] Fix trimming warnings in HttpClientHandler.AnyMobileSep 8, 2023
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-android

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival
simonrozsival merged commit 7f06d1c into dotnet:mainSep 8, 2023
@simonrozsival
simonrozsival deleted the http-client-handler-anymobile-suppress-ilc-warning branch September 8, 2023 19:07
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0-rc1

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0-rc1: https://github.com/dotnet/runtime/actions/runs/6130417198

@stephentoub

Copy link
Copy Markdown
Member

Was release/8.0-rc1 correct or should it have been release/8.0 instead?

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@stephentoub you're right, it shouldn't be RC1. I'll open a new backport.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0: https://github.com/dotnet/runtime/actions/runs/6145796878

InvokeNativeHandlerMethod(getMethod, parameters: new object?[] { value }, cachingKey!);
}

private object InvokeNativeHandlerMethod(Func<MethodInfo> getMethod, object?[]? parameters, string cachingKey)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it not static?


private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)
{
return InvokeNativeHandlerMethod(getMethod, parameters: null, cachingKey!);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add Debug.Assert instead of only !

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps Type.GetType(NativeHandlerType) could come as an argument to the lambda and you could cache it too.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I understand it, by keeping the GetType and GetMethod calls together with constant arguments will give the trimmer enough information to keep only the methods that are actually used. If we cached the type, I think it wouldn't be trimmable anymore.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true. We don't have a way to do this with caching the Type (without suppressing some warnings).
Once we have UnsafeAccessorType then this can be rewritten to use that and it will not use any reflection and be faster.

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the lambdas should be static (not sure why the analyzer does not complain).

return (HttpMessageHandler)_nativeHandlerMethod!.Invoke(null, null)!;
}

private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could use CallerLineNumberAttribute or some other key which is not a next string in the assembly

@karelzkarelz added this to the 9.0.0 milestone Sep 14, 2023
@ghostghost locked as resolved and limited conversation to collaborators Oct 14, 2023
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Net.Httplinkable-frameworkIssues associated with delivering a linker friendly frameworkos-iosApple iOS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@simonrozsival@MichalStrehovsky@stephentoub@marek-safar@akoeplinger@eerhardt@vitek-karas@karelz
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile - #91520

Merged
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning
Sep 8, 2023
Merged

[iOS] Fix trimming warnings in HttpClientHandler.AnyMobile#91520
simonrozsival merged 3 commits into
dotnet:mainfrom
simonrozsival:http-client-handler-anymobile-suppress-ilc-warning

Conversation

@simonrozsival

@simonrozsivalsimonrozsival commented Sep 3, 2023

Copy link
Copy Markdown
Member

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

This PR fixes the warning.

@ghost

ghost commented Sep 3, 2023

Copy link
Copy Markdown

Tagging subscribers to this area: @dotnet/ncl
See info in area-owners.md if you want to be subscribed.

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:-
Labels:

area-System.Net.Http, os-ios

Milestone:-

@simonrozsival

This comment was marked as outdated.

@azure-pipelines

This comment was marked as outdated.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-extra-platforms

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky added the linkable-framework Issues associated with delivering a linker friendly framework label Sep 7, 2023
@ghost

ghost commented Sep 7, 2023

Copy link
Copy Markdown

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

Issue Details

While testing NativeAOT on iOS, I started noticed this warning from ILC:

ILC : Trim analysis warning IL2075: System.Net.Http.HttpClientHandler.InvokeNativeHandlerMethod(String,Object[]): 'this' argument does not satisfy 'DynamicallyAccessedMemberTypes.PublicMethods' in call to 'System.Type.GetMethod(String)'. The return value of method 'System.Object.GetType()' does not have matching annotations. The source value must declare at least the same requirements as those declared on the target location it is assigned to. 

All the methods which call InvokeNativeHandlerMethod are annotated with DynamicDependency attributes and so the warning we get from ILC can be suppressed.

Author:simonrozsival
Assignees:simonrozsival
Labels:

area-System.Net.Http, linkable-framework, os-ios

Milestone:-

@MichalStrehovsky

Copy link
Copy Markdown
Member

We typically write targeted trimming tests if there is a suppression. Suppressions are not great because someone could add a new callsite and forget to add DynamicDependency (or DynamicDependency the wrong thing).

I think this can be rewritten to be correct by construction. All the text strings are there, they're just too far apart for analysis to figure them out.

Basically, I'd do this:

  • Delete all the DynamicDependency stuff.
  • Replace _nativeHandler!.GetType()!.GetMethod(name); in InvokeNativeHandlerMethod with Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name);. The C# compiler will concatenate these strings because they're all consts.
  • This is already enough to make everything work. Trimming will keep all public methods on the type and there will be no warning. This is because the name of the type is visible within the InvokeNativeHandlerMethod method.
  • If there is a size concern (we don't want to keep all the public methods on this type), we could hoist the Type.GetType(NativeHandlerType + ", " + AssemblyName)!.GetMethod(name); part into a delegate (add an Action<MethodInfo> delegate parameter to InvokeNativeHandlerMethod and provide the right implementation at each callsite as a lambda). This should result in comparable size to what was achieved with DynamicDependency (the attributes are not cheap, size-wise - it's a lot of characters and none of them can be shared even though they're identical because custom attributes are encoded that way).

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@MichalStrehovsky thanks for the suggestion!

@simonrozsival
simonrozsival marked this pull request as draft September 7, 2023 13:46
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-ioslike

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@MichalStrehovskyMichalStrehovsky left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! (Reviewing from the trimmability perspective only.)

Cc @AaronRobinsonMSFT - I think this is a nice candidate for #90081. We'll be able to simplify all of this and get rid of the reflection.

@simonrozsivalsimonrozsival changed the title [iOS] Unconditionally suppress trimming warnings in HttpClientHandler[iOS] Fix trimming warnings in HttpClientHandler.AnyMobileSep 8, 2023
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/azp run runtime-android

@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines successfully started running 1 pipeline(s).

@simonrozsival
simonrozsival merged commit 7f06d1c into dotnet:mainSep 8, 2023
@simonrozsival
simonrozsival deleted the http-client-handler-anymobile-suppress-ilc-warning branch September 8, 2023 19:07
@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0-rc1

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0-rc1: https://github.com/dotnet/runtime/actions/runs/6130417198

@stephentoub

Copy link
Copy Markdown
Member

Was release/8.0-rc1 correct or should it have been release/8.0 instead?

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

@stephentoub you're right, it shouldn't be RC1. I'll open a new backport.

@simonrozsival

Copy link
Copy Markdown
MemberAuthor

/backport to release/8.0

@github-actions

Copy link
Copy Markdown
Contributor

Started backporting to release/8.0: https://github.com/dotnet/runtime/actions/runs/6145796878

InvokeNativeHandlerMethod(getMethod, parameters: new object?[] { value }, cachingKey!);
}

private object InvokeNativeHandlerMethod(Func<MethodInfo> getMethod, object?[]? parameters, string cachingKey)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is it not static?


private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)
{
return InvokeNativeHandlerMethod(getMethod, parameters: null, cachingKey!);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add Debug.Assert instead of only !

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps Type.GetType(NativeHandlerType) could come as an argument to the lambda and you could cache it too.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I understand it, by keeping the GetType and GetMethod calls together with constant arguments will give the trimmer enough information to keep only the methods that are actually used. If we cached the type, I think it wouldn't be trimmable anymore.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's true. We don't have a way to do this with caching the Type (without suppressing some warnings).
Once we have UnsafeAccessorType then this can be rewritten to use that and it will not use any reflection and be faster.

[DynamicDependency("set_Credentials", NativeHandlerType, AssemblyName)]
private void SetCredentials(ICredentials? value) => InvokeNativeHandlerMethod("set_Credentials", value);
private void SetCredentials(ICredentials? value)
=> InvokeNativeHandlerSetter(() => Type.GetType(NativeHandlerType)!.GetMethod("set_Credentials")!, value);

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the lambdas should be static (not sure why the analyzer does not complain).

return (HttpMessageHandler)_nativeHandlerMethod!.Invoke(null, null)!;
}

private object InvokeNativeHandlerGetter(Func<MethodInfo> getMethod, [CallerMemberName] string? cachingKey = null)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we could use CallerLineNumberAttribute or some other key which is not a next string in the assembly

@karelzkarelz added this to the 9.0.0 milestone Sep 14, 2023
@ghostghost locked as resolved and limited conversation to collaborators Oct 14, 2023
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-System.Net.Httplinkable-frameworkIssues associated with delivering a linker friendly frameworkos-iosApple iOS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@simonrozsival@MichalStrehovsky@stephentoub@marek-safar@akoeplinger@eerhardt@vitek-karas@karelz