Source Generator Performance Improvements #19990

mgoertz-msft · 2024-01-19T01:44:42Z

Description of Change

Source Generator Performance Improvements:

Reversed lookup order (Extension second)
Introduced type cache
Restored lookup order (Extension first again)

PERF PROGRESS
Updated numbers. Not quite as dramatic but still a good improvement. The original measurements had a TracePoint skewing the timing results quite heavily. The new numbers only use a StopWatch in code with the TracePoint disabled.

SourceGen - Maui.Controls.Sample (262 XAML files)

1) Unchanged:
- 15640 GetTypeByMetadata calls
~ 4s

2) Extensions lookup in XmlTypeXamlExtensions.GetTypeReference() second
- 6232 GetTypeByMetadata calls (~60% reduction)
~ 2.6s                         (~35% reduction)

3) With type cache and Extension lookup second
- 203 GetTypeByMetadata calls  (~99% reduction)
~ 1.5s                         (~62% reduction => ~2.6 times faster)

4) With just a type cache
- 523 GetTypeByMetadata calls  (~97% reduction)
~ 1.5s                         (~62% reduction => ~2.6 times faster)

Issues Fixed

Fixes #19944 GetTypeNameFromCustomNamespace does not cache duplicate results

src/Controls/src/Xaml/XamlNode.cs

src/Controls/src/SourceGen/CodeBehindGenerator.cs

src/Controls/src/Xaml/XmlTypeXamlExtensions.cs

StephaneDelcroix · 2024-01-23T10:54:24Z

/rebase

- Reversed lookup order (Extension second) - Introduced type cache ``` PERF PROGRESS: SourceGen - Maui.Controls.Sample (262 XAML files) 1) Unchanged: - 15640 GetTypeByMetadata calls - 223s 2) Extensions lookup in XmlTypeXamlExtensions.GetTypeReference() second - 6232 GetTypeByMetadata calls (~60% reduction) - 90s (~60% reduction) 3) With type cache - 203 GetTypeByMetadata calls (~97% reduction => ~99% total reduction) - 6s (~93% reduction => ~97% total reduction => 37 times faster!) ```

…an 2

rmarinho

It's failing the build..

VisualRunner/Pages/TestAssemblyPage.xaml(17,30): XamlC error XFC0009: No property, BindableProperty, or event found for "Type", or mismatching type between value and property. [/Users/builder/azdo/_work/2/s/src/TestUtils/src/DeviceTests.Runners/TestUtils.DeviceTests.Runners.csproj::TargetFramework=net8.0-android]

mgoertz-msft · 2024-01-23T18:49:29Z

Thanks, saw that too. I'm not sure why that would be failing now. Need to look into that...

…d potentially breaking behavior for scenarios besides x:Array. In this case XamlC preferred System.Array over ArrayExtension for x:Array. With the typecache it made no measurable difference in performance.

mgoertz-msft · 2024-01-26T15:53:20Z

@rmarinho Could you please review again? I had to switch the Extension lookup order back because it preferred System.Array over ArrayExtension for x:Array, and it's probably safer to keep this way in case there are other scenarios like this that we may not be aware about. The cache brought the real improvement so this lookup switch wasn't needed anyway.

rmarinho · 2024-01-26T16:05:48Z

src/Controls/src/SourceGen/Properties/launchSettings.json

@@ -0,0 +1,8 @@
+{
+  "profiles": {


Is this something we want to check in ?

I actually think we do. It provides a simple debug target to debug the source generator.

rmarinho

Seems good just a comment about the launchSettings, and I wonder if we could add a Benchmark around this change? But not blocking to get it merged.

mgoertz-msft · 2024-01-26T16:23:59Z

I wonder if we could add a Benchmark around this change?

How do you do that? Do you have an example?

jonathanpeppers · 2024-01-26T16:25:34Z

There is a BenchmarkDotNet project, but it's not setup to test things like source generators or MSBuild tasks:

https://github.com/dotnet/maui/tree/main/src/Core/tests/Benchmarks/Benchmarks

In theory, we could make a Benchmarks.Build or Benchmarks.Tooling project for things like this.

* Add Obsolete tag for old IndexOf (#20068) * Split the InputTransparency tests (#19925) * Bump Xamarin.UITest to 4.3.4 (#20067) * Bump Xamarin.UITest to 4.3.4 * Update NUnit * Restore dotnet tool (#20106) * Do not use underscores in the ApplicationId (#19377) * Do not use underscores in the ApplicationId Underscores are not supported on Windows * Update DotnetInternal.cs * [WinUI] Add workaround for Connectivity check on Win10 (#19261) * Implemented a Win10 work-around for connectivity thread issue Reimplement `ConnectivityImplementation.ConnectionProfiles` to use native .net core APIs * Remove prop bag ID * Replace network availability changed event with native .net API * Remove explicit file include * Fix file naming * Implemented a Win10 work-around for connectivity thread issue Reimplement `ConnectivityImplementation.ConnectionProfiles` to use native .net core APIs * Remove prop bag ID * Replace network availability changed event with native .net API * Remove explicit file include * Fix file naming * * Revert change to remove `Windows.Networking.Connectivity.NetworkInformation.NetworkStatusChanged` * Update Connectivity.uwp.cs --------- Co-authored-by: Mike Corsaro <[email protected]> Co-authored-by: Matthew Leibowitz <[email protected]> * [Windows] Adjust recycle check in ItemContentControl (#20079) * Adjust recycle check in `ItemContentControl` to use Content property * Fix confusing line * Rectify the scopes in the builder (#19932) * Update System.Drawing.Common (#20122) * Enable building WASDK Self-Contained packaged apps (#20019) * Translucent and Transparent NavigationBar on iOS (#19204) * Changes for enabling translucent navigation bar ios * Add UITest for NavigationPage Safe Area Translucence * remove UIKit * Move UITest from gallery to Issues * push a new page for UITests, consolidate code, and save shadowimage * Changes for enabling translucent navigation bar ios * Add UITest for NavigationPage Safe Area Translucence * remove UIKit * Move UITest from gallery to Issues * make the extension method * use the background color alpha for translucent * use same alpha logic for pre ios 15 * accidently added testing comments * add more UITests for the different NavigationPage and Flyout Page scenarios * use additionalsafeareainsets for the secondary toolbar * missing new line * only run the secondary toolbar offset when we have a secondary toolbar * use existing childViewControllers * remove the shadow stuff and simplify the expression with null * style and fixes from merge conflicts * standardAppearance and scrolledgeappearance should be kept in * changes after talking with Shane * change shell behavior to be more like navrenderer with preiOS13 * move code if we are transparent pre13 shell * remove new lines * add screenshot tests * be able to remove and add secondarybar additionalsafeareas * reset the xaml on the Sandboc MainPage (#20082) * [Android] Fix gif animation initial state (#14295) * Fix gifs initial animation state on Android * Device tests * Auto-format source code * Updated sample * Updated device tests * Refactor code * Update src/Core/src/Handlers/Image/ImageHandler.Android.cs Co-authored-by: Matthew Leibowitz <[email protected]> * Remove unnecessary change * Fix build errors * Merge branch 'main' into fix-7019 * Fix merge mistake --------- Co-authored-by: GitHub Actions Autoformatter <[email protected]> Co-authored-by: Javier Suárez <[email protected]> Co-authored-by: Matthew Leibowitz <[email protected]> Co-authored-by: Gerald Versluis <[email protected]> * Enable Windows Image device tests (#20167) * [X] allow x:Type extension for BPConverter (#18540) - fixes #18324 * Source Generator Performance Improvements (#19990) * Source Generator Performance Improvements: - Reversed lookup order (Extension second) - Introduced type cache ``` PERF PROGRESS: SourceGen - Maui.Controls.Sample (262 XAML files) 1) Unchanged: - 15640 GetTypeByMetadata calls - 223s 2) Extensions lookup in XmlTypeXamlExtensions.GetTypeReference() second - 6232 GetTypeByMetadata calls (~60% reduction) - 90s (~60% reduction) 3) With type cache - 203 GetTypeByMetadata calls (~97% reduction => ~99% total reduction) - 6s (~93% reduction => ~97% total reduction => 37 times faster!) ``` * - Set uinitial lookupNames capacity to 2 since there won't be more than 2 * Added appium UITest for FlyoutNavigationBetweenItemsWithNavigationStacks (#19444) Fixes #16675 * Add better exception for missing Maps on Windows (#19046) * Add better exception for missing Maps on Windows * Update AppHostBuilderExtensions.cs * [ci] Add missing demands (#20183) * Add comments to internal methods for XAML Hot Reload usage (#20215) * Add comments to internal methods for XAML Hot Reload usage * spacing * Adding Mobile tag to MAUI project templates (#20191) Co-authored-by: Luke Westendorf <[email protected]> --------- Co-authored-by: Tim Miller <[email protected]> Co-authored-by: Matthew Leibowitz <[email protected]> Co-authored-by: Gerald Versluis <[email protected]> Co-authored-by: Mike Corsaro <[email protected]> Co-authored-by: Mike Corsaro <[email protected]> Co-authored-by: TJ Lambert <[email protected]> Co-authored-by: Javier Suárez <[email protected]> Co-authored-by: GitHub Actions Autoformatter <[email protected]> Co-authored-by: Javier Suárez <[email protected]> Co-authored-by: Stephane Delcroix <[email protected]> Co-authored-by: Marco Goertz <[email protected]> Co-authored-by: MSLukeWest <[email protected]> Co-authored-by: Luke Westendorf <[email protected]>

* Source Generator Performance Improvements: - Reversed lookup order (Extension second) - Introduced type cache ``` PERF PROGRESS: SourceGen - Maui.Controls.Sample (262 XAML files) 1) Unchanged: - 15640 GetTypeByMetadata calls - 223s 2) Extensions lookup in XmlTypeXamlExtensions.GetTypeReference() second - 6232 GetTypeByMetadata calls (~60% reduction) - 90s (~60% reduction) 3) With type cache - 203 GetTypeByMetadata calls (~97% reduction => ~99% total reduction) - 6s (~93% reduction => ~97% total reduction => 37 times faster!) ``` * - Set uinitial lookupNames capacity to 2 since there won't be more than 2

mgoertz-msft requested a review from a team as a code owner January 19, 2024 01:44

mgoertz-msft requested review from rmarinho and jsuarezruiz January 19, 2024 01:44

mattleibow requested a review from StephaneDelcroix January 19, 2024 07:38

StephaneDelcroix previously approved these changes Jan 19, 2024

View reviewed changes

jonathanpeppers reviewed Jan 19, 2024

View reviewed changes

src/Controls/src/Xaml/XamlNode.cs Outdated Show resolved Hide resolved

src/Controls/src/SourceGen/CodeBehindGenerator.cs Show resolved Hide resolved

src/Controls/src/Xaml/XmlTypeXamlExtensions.cs Outdated Show resolved Hide resolved

Eilon added the area-xaml XAML, CSS, Triggers, Behaviors label Jan 20, 2024

mgoertz-msft dismissed StephaneDelcroix’s stale review via f9c0946 January 22, 2024 22:20

jonathanpeppers previously approved these changes Jan 22, 2024

View reviewed changes

mgoertz-msft enabled auto-merge (squash) January 23, 2024 00:11

mgoertz-msft dismissed jonathanpeppers’s stale review via b1cc7d9 January 23, 2024 00:27

StephaneDelcroix previously approved these changes Jan 23, 2024

View reviewed changes

mgoertz-msft added 3 commits January 23, 2024 10:54

- Set uinitial lookupNames capacity to 2 since there won't be more th…

8a7b2ce

…an 2

- Followed existing patterns for string.GetHashCode usage

58fc951

github-actions bot force-pushed the dev/mgoertz/typecache branch from b1cc7d9 to 58fc951 Compare January 23, 2024 10:55

rmarinho requested changes Jan 23, 2024

View reviewed changes

Fixed the build break by putting Extension lookup first again to avoi…

1bc436e

…d potentially breaking behavior for scenarios besides x:Array. In this case XamlC preferred System.Array over ArrayExtension for x:Array. With the typecache it made no measurable difference in performance.

mgoertz-msft dismissed StephaneDelcroix’s stale review via 1bc436e January 26, 2024 01:39

rmarinho self-requested a review January 26, 2024 13:58

rmarinho reviewed Jan 26, 2024

View reviewed changes

rmarinho approved these changes Jan 26, 2024

View reviewed changes

mgoertz-msft merged commit 08f1f61 into main Jan 26, 2024
47 checks passed

mgoertz-msft deleted the dev/mgoertz/typecache branch January 26, 2024 16:07

github-actions bot locked and limited conversation to collaborators Feb 26, 2024

samhouts added fixed-in-8.0.10 fixed-in-9.0.0-preview.2.10247 fixed-in-9.0.100-preview.1.9973 labels Aug 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Source Generator Performance Improvements #19990

Source Generator Performance Improvements #19990

mgoertz-msft commented Jan 19, 2024 •

edited

Loading

StephaneDelcroix commented Jan 23, 2024

rmarinho left a comment

mgoertz-msft commented Jan 23, 2024

mgoertz-msft commented Jan 26, 2024

rmarinho Jan 26, 2024

mgoertz-msft Jan 26, 2024

rmarinho left a comment

mgoertz-msft commented Jan 26, 2024

jonathanpeppers commented Jan 26, 2024

Source Generator Performance Improvements #19990

Source Generator Performance Improvements #19990

Conversation

mgoertz-msft commented Jan 19, 2024 • edited Loading

Description of Change

Issues Fixed

StephaneDelcroix commented Jan 23, 2024

rmarinho left a comment

Choose a reason for hiding this comment

mgoertz-msft commented Jan 23, 2024

mgoertz-msft commented Jan 26, 2024

rmarinho Jan 26, 2024

Choose a reason for hiding this comment

mgoertz-msft Jan 26, 2024

Choose a reason for hiding this comment

rmarinho left a comment

Choose a reason for hiding this comment

mgoertz-msft commented Jan 26, 2024

jonathanpeppers commented Jan 26, 2024

mgoertz-msft commented Jan 19, 2024 •

edited

Loading