NotificationsYou must be signed in to change notification settings
Fork5.2k
Star17.2k

Improve WebUtility.HtmlEncode / UrlEncode performance#103737

New issue

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

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

Already on GitHub?Sign in to your account

Jump to bottom

Merged

stephentoub merged 2 commits intodotnet:mainfromstephentoub:webutilperf

Jun 21, 2024

Merged

Improve WebUtility.HtmlEncode / UrlEncode performance#103737

stephentoub merged 2 commits intodotnet:mainfromstephentoub:webutilperf

Jun 21, 2024

Conversation

Copy link

Member

stephentoub commentedJun 19, 2024

For HtmlEncode, vectorize IndexOfHtmlEncodingChars. Using SearchValues, we can efficiently search for the first ASCII encoding char or the first non-ASCII char, and only then fall back to a scalar loop.
For HtmlEncode, reduce branching by using a more efficient check to determine whether the ASCII characters need to be encoded.
For UrlEncode, rather than UTF8-encoding into a new byte[], %-encoding in-place in that, and then creating a string from that, we can use string.Create and just do all the encoding in that buffer.
For UrlEncode, use SearchValues to vectorize the search for the first non-safe char. Also move the check for ' ' to be inside the if for non-safe char.
For UrlEncode, use SearchValues to optimize the check for whether an individual character is part of the set (via Contains).
Simplify IsUrlSafeChar. Rather than multiple checks, one of which is a bitmap, just have a bitmap.
Remove some leading IsNullOrEmpty checks. Null/empty inputs should be rare, and they're now handled implicitly as part of the subsequent loops.

usingBenchmarkDotNet.Attributes;usingBenchmarkDotNet.Running;usingSystem.Net;BenchmarkSwitcher.FromAssembly(typeof(Program).Assembly).Run(args);[MemoryDiagnoser]publicclassTests{[Benchmark][ArgumentsSource(nameof(Inputs))]publicstringHtmlEncode(stringinput)=>WebUtility.HtmlEncode(input);[Benchmark][ArgumentsSource(nameof(Inputs))]publicstringUrlEncode(stringinput)=>WebUtility.UrlEncode(input);publicIEnumerable<object[]>Inputs()=>[["this-is-a-very-long-filename-for-an-image-that-should-not-need-encoding.jpg"],["short_name.txt"],["https://www.example.com"],["<test>hello, world</test>"],["לילה טוב"],["""         How much wood could a woodchuck chuck         If a woodchuck could chuck wood?         A woodchuck would chuck as much wood         As much wood as a woodchuck could chuck,         If a woodchuck could chuck wood.         """]];}

Method	Toolchain	input	Mean	Ratio	Allocated	Alloc Ratio
HtmlEncode	\main\corerun.exe	<test(...)test> [25]	81.576 ns	1.00	96 B	1.00
HtmlEncode	\pr\corerun.exe	<test(...)test> [25]	80.366 ns	0.97	96 B	1.00

UrlEncode	\main\corerun.exe	<test(...)test> [25]	118.515 ns	1.00	160 B	1.00
UrlEncode	\pr\corerun.exe	<test(...)test> [25]	103.039 ns	0.87	96 B	0.60

HtmlEncode	\main\corerun.exe	How (...)ood. [185]	164.359 ns	1.00	-	NA
HtmlEncode	\pr\corerun.exe	How (...)ood. [185]	10.142 ns	0.06	-	NA

UrlEncode	\main\corerun.exe	How (...)ood. [185]	537.945 ns	1.00	664 B	1.00
UrlEncode	\pr\corerun.exe	How (...)ood. [185]	466.832 ns	0.86	432 B	0.65

HtmlEncode	\main\corerun.exe	https(...)e.com [23]	21.442 ns	1.00	-	NA
HtmlEncode	\pr\corerun.exe	https(...)e.com [23]	4.732 ns	0.22	-	NA

UrlEncode	\main\corerun.exe	https(...)e.com [23]	103.053 ns	1.00	136 B	1.00
UrlEncode	\pr\corerun.exe	https(...)e.com [23]	76.013 ns	0.73	80 B	0.59

HtmlEncode	\main\corerun.exe	short_name.txt	13.068 ns	1.00	-	NA
HtmlEncode	\pr\corerun.exe	short_name.txt	4.876 ns	0.38	-	NA

UrlEncode	\main\corerun.exe	short_name.txt	14.324 ns	1.00	-	NA
UrlEncode	\pr\corerun.exe	short_name.txt	3.600 ns	0.26	-	NA

HtmlEncode	\main\corerun.exe	this-(...)g.jpg [75]	62.800 ns	1.00	-	NA
HtmlEncode	\pr\corerun.exe	this-(...)g.jpg [75]	6.975 ns	0.11	-	NA

UrlEncode	\main\corerun.exe	this-(...)g.jpg [75]	70.709 ns	1.00	-	NA
UrlEncode	\pr\corerun.exe	this-(...)g.jpg [75]	5.611 ns	0.08	-	NA

HtmlEncode	\main\corerun.exe	לילה טוב	8.436 ns	1.00	-	NA
HtmlEncode	\pr\corerun.exe	לילה טוב	11.427 ns	1.36	-	NA

UrlEncode	\main\corerun.exe	לילה טוב	100.852 ns	1.00	184 B	1.00
UrlEncode	\pr\corerun.exe	לילה טוב	74.544 ns	0.74	112 B	0.61

Improve WebUtility.HtmlEncode / UrlEncode performance

3402b18

- For HtmlEncode, vectorize IndexOfHtmlEncodingChars. Using SearchValues, we can efficiently search for the first ASCII encoding char or the first non-ASCII char, and only then fall back to a scalar loop.- For HtmlEncode, reduce branching by using a more efficient check to determine whether the ASCII characters need to be encoded.- For UrlEncode, rather than UTF8-encoding into a new byte[], %-encoding in-place in that, and then creating a string from that, we can use string.Create and just do all the encoding in that buffer.- For UrlEncode, use SearchValues to vectorize the search for the first non-safe char. Also move the check for ' ' to be inside the if for non-safe char.- For UrlEncode, use SearchValues to optimize the check for whether an individual character is part of the set (via Contains).- Simplify IsUrlSafeChar. Rather than multiple checks, one of which is a bitmap, just have a bitmap.- Remove some leading IsNullOrEmpty checks. Null/empty inputs should be rare, and they're now handled implicitly as part of the subsequent loops.

stephentoub requested a review fromMihaZupan

June 19, 2024 23:41

ghost added the area-System.Net label

Jun 19, 2024

dotnet-policy-servicebot assignedstephentoub

Jun 19, 2024

Copy link

Contributor

dotnet-policy-servicebot commentedJun 19, 2024

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

This was referencedJun 20, 2024

System.IO.Net5Compat.Tests and System.IO.Tests suddenly exiting with error 137#100558

Closed

NativeAOT legs timing out in CI#102239

Closed

The Operation will be canceled. The next steps may not contain expected logs.dotnet/dnceng#3008

Open

GC/Regressions/v2.0-beta2/452950 failed in CI#103494

Closed

FileSystemWatcher_InternalBufferSize_SynchronizingObject test failed in CI#103495

Closed

System.IO.Tests.Directory_Create_Tests.FileSystemWatcher_Directory_Create_InNestedDirectory fails with "Created event did not occur as expected"#103630

Open

STJ NullPropertyNameFail test failing in CI#103715

Closed

MihaZupan approved these changes

Jun 20, 2024

View reviewed changes

Copy link

Member

MihaZupan left a comment

Choose a reason for hiding this comment

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

Always love to see SearchValues ratios like these

Method	Toolchain	input	Mean	Ratio	Allocated	Alloc Ratio
HtmlEncode	\main\corerun.exe	How (...)ood. [185]	164.359 ns	1.00	-	NA
HtmlEncode	\pr\corerun.exe	How (...)ood. [185]	10.142 ns	0.06	-	NA

src/libraries/System.Private.CoreLib/src/System/Net/WebUtility.cs OutdatedShow resolvedHide resolved

MihaZupan added this to the9.0.0 milestone

Jun 20, 2024

This was referencedJun 20, 2024

[Test Failure] System.IO.Tests.InternalBufferSizeTests.FileSystemWatcher_InternalBufferSize#103753

Closed

[Test Failure] System.Net.Http.WinHttpHandlerFunctional.Tests.BidirectionStreamingTest.BackwardsCompatibility_DowngradeToHttp11#103754

Closed

Update src/libraries/System.Private.CoreLib/src/System/Net/WebUtility.cs

05a5185

Co-authored-by: Miha Zupan <mihazupan.zupan1@gmail.com>

stephentoub merged commitb1bb871 intodotnet:main

Jun 21, 2024

stephentoub deleted the webutilperf branch

June 21, 2024 13:57

rzikm pushed a commit to rzikm/dotnet-runtime that referenced this pull request

Jun 24, 2024

Improve WebUtility.HtmlEncode / UrlEncode performance (dotnet#103737)

ee9205d

* Improve WebUtility.HtmlEncode / UrlEncode performance- For HtmlEncode, vectorize IndexOfHtmlEncodingChars. Using SearchValues, we can efficiently search for the first ASCII encoding char or the first non-ASCII char, and only then fall back to a scalar loop.- For HtmlEncode, reduce branching by using a more efficient check to determine whether the ASCII characters need to be encoded.- For UrlEncode, rather than UTF8-encoding into a new byte[], %-encoding in-place in that, and then creating a string from that, we can use string.Create and just do all the encoding in that buffer.- For UrlEncode, use SearchValues to vectorize the search for the first non-safe char. Also move the check for ' ' to be inside the if for non-safe char.- For UrlEncode, use SearchValues to optimize the check for whether an individual character is part of the set (via Contains).- Simplify IsUrlSafeChar. Rather than multiple checks, one of which is a bitmap, just have a bitmap.- Remove some leading IsNullOrEmpty checks. Null/empty inputs should be rare, and they're now handled implicitly as part of the subsequent loops.* Update src/libraries/System.Private.CoreLib/src/System/Net/WebUtility.csCo-authored-by: Miha Zupan <mihazupan.zupan1@gmail.com>---------Co-authored-by: Miha Zupan <mihazupan.zupan1@gmail.com>