Implement precompiled queries by roji · Pull Request #33297 · dotnet/efcore

roji · 2024-03-12T15:16:30Z

The precompiled query work is in good enough shape that I think it's the right moment to submit as a draft PR. There are still various test failures, checks and cleanups which I plan to implement, but it's more about edge cases at this point - the overall architecture should be sound. I'm happy to do a session with whoever wants to dive in and at least explain the general approach (we can also do a brown bag at some point if people want to).

Notes:

This PR is based on top of Introduce liftable constants to shaper to prepare for precompilation #32721 (liftable constants in shaper), which @maumar is working on (take care to filter out the 1st commit when reviewing). The shaper work must be complete for this PR to be completed.
One main reason to submit this now, is to allow @AndriySvyryd to react:
- LinqToCSharpSyntaxTranslator now generates unsafe accessors when it encounters private field/property accesses; @AndriySvyryd I think this can be used instead of the previous "method access replacements" approach for compiled model generation, where the unsafe accessors are pre-generated externally and then substituted in the overriding implementation.
- Work can begin on integrating this into MSBuild.
This is a pretty massive PR, implementing the bulk (and probably most complex parts) of precompiled queries; the more eyes on this, the better.

Closes #31331

roji · 2024-03-12T15:25:26Z

src/EFCore.Design/Query/Internal/PrecompiledQueryCodeGenerator.cs

+    ///     any release. You should only use it directly in your code with extreme caution and knowing that
+    ///     doing so can result in application failures when updating to a new Entity Framework Core release.
+    /// </summary>
+    public async Task GeneratePrecompiledQueries(


Mainly for @AndriySvyryd: this method is currently just hacked up to be invoked from e.g. an external console program, and needs to be adapted (in case it's not obvious). The precompiled query tests I've been working with call the method below, which just accepts a Compilation directly.

roji · 2024-03-12T15:27:47Z

src/EFCore.Design/Scaffolding/Internal/CSharpRuntimeModelCodeGenerator.cs

            out var createCollection);

+        // TODO
+        var unsafeAccessors = new HashSet<string>();


@AndriySvyryd note the unsafe accessors now getting generated inside LinqToCSharpSyntaxTranslators - ideally these would be used here instead of the current method replacements mechanism?

There are two reasons why I implemented them differently:

Avoid generating duplicate accessors for the same members

Support private property access

For the deduplication, this already occurs within the translator itself, so we could expose what's needed to allow deduplication across multiple invocations of the translator. For example, we could have the same instance of the translator accumulate unsafe accessor declarations internally as its reused, and at the end you'd all of them via a special API. Or we could externalize that state so you'd pass it back in, etc.

(For that state, originally I had a nice and clean dictionary from MemberInfo to the MethodDeclarationSyntax representing its interceptor - but needing different interceptors for field read/write makes that a tiny bit more complex.)

Private property access should also already be implemented in the translator - let me know if you see an issue.

Using the same instance won't help when processing an assembly that doesn't contain the compiled model.

I was thinking that we can store memberAccessReplacements as an annotation in the compiled model and precompiled queries would use it. If you think that it's possible to have queries that access a private member that's not in the model then we can also keep unsafeAccessors

So FWIW, I looked again and the current implementation already deduplicates unsafe accessors across invocations (i.e. across shapers of different queries) - the state passed around is simply ISet<MethodDeclarationSyntax>, and at the end we dump that out into the generated file.

Using the same instance won't help when processing an assembly that doesn't contain the compiled model.

Let's do a call so I can understand this better (possibly tomorrow before/after the design meeting?)

@AndriySvyryd for now I've left the these changes as they are in the PR, let's revisit and clean up after merge OK?

src/EFCore.Design/Query/Internal/PrecompiledQueryCodeGenerator.cs

roji

I've more of less finished what I consider to be the most of the work here. There are some edge cases I know which aren't handled (and most probably some others I don't know), but I think it's in good enough shape to merge and fix local problems later.

So moving this out of draft state - it should be ready for a good review. Note that this is still based on top of #33351 which isn't yet done; be sure to exclude that when reviewing.

roji · 2024-04-07T17:28:02Z

src/EFCore.Relational/Query/SqlExpressions/SelectExpression.Helper.cs

                    selectExpression.Orderings,
-                    selectExpression.Limit,
-                    selectExpression.Offset));
+                    selectExpression.Offset,


Note that here - and below - I'm generally moving arround SelectExpression components to be in the order in which they're evaluated in SQL (i.e. offset before limit). We weren't always consistent, and the confusion can be hard to track down.

roji · 2024-04-07T17:30:06Z

src/EFCore.Design/Scaffolding/Internal/CSharpRuntimeModelCodeGenerator.cs

            out var createCollection);

+        // TODO
+        var unsafeAccessors = new HashSet<string>();


@AndriySvyryd for now I've left the these changes as they are in the PR, let's revisit and clean up after merge OK?

cincuranet · 2024-04-08T12:25:30Z

be sure to exclude that when reviewing.

For your convenience: https://github.com/dotnet/efcore/pull/33297/files/b66d7b9c4fd5846ff6e6afa8e71dfe2f97983aa5..53025c3bfb3503257a49f2d96327e4c9ee1485db

src/EFCore.Design/Properties/DesignStrings.resx

src/EFCore.Design/Query/Internal/CSharpToLinqTranslator.cs

roji · 2024-04-08T21:54:28Z

/azp run

azure-pipelines · 2024-04-08T21:54:36Z

Azure Pipelines successfully started running 1 pipeline(s).

src/EFCore.Design/Query/Internal/QueryLocator.cs

cincuranet · 2024-04-09T14:12:02Z

test/EFCore.Design.Tests/EFCore.Design.Tests.csproj


  <ItemGroup>
-    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="$(MicrosoftCodeAnalysisVersion)" />
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.10.0-2.final" />


This should be probably fixed back before merging.

This version contains an interceptor-related compiler fix which is required for the tests to run successfully - so I don't think we'll be able to change this back. However, it's a test-only dependency on a preview package, and 4.10.0 should release for 9.0, at which point hopefully we can align everything.

I mean we can change the MicrosoftCodeAnalysisVersion variable. For 9.0 RTM everything will align fine.

We can, but this would limit the SDK versions that can be used by ordinary users with EF... We've had issues with changes like this in the past - given that we only need this in testing, I'd rather we left things as-is for now and update later as needed...

test/EFCore.Relational.Specification.Tests/EFCore.Relational.Specification.Tests.csproj

...es/Custom_function_parameter_type_mapping/FunctionParameterTypeMappingContextModelBuilder.cs

src/EFCore/Query/ExpressionPrinter.cs

src/EFCore.Design/Query/Internal/CSharpToLinqTranslator.cs

AndriySvyryd · 2024-04-20T01:33:16Z

src/EFCore.Design/Query/Internal/CSharpToLinqTranslator.cs

+            // containing type (and recursively, its containing types)
+            var typeTypeParameterMap = new Dictionary<string, Type>(GetTypeTypeParameters(methodSymbol.ContainingType));
+
+            IEnumerable<KeyValuePair<string, Type>> GetTypeTypeParameters(INamedTypeSymbol typeSymbol)


Move to the end and make static

I don't think this can be static, since it invokes ResolveType... But moving to the end.

AndriySvyryd · 2024-04-20T01:40:40Z

src/EFCore.Design/Query/Internal/CSharpToLinqTranslator.cs

+            ? ResolveType(typeSymbol)
+            : throw new InvalidOperationException("Could not find type symbol for: " + node);
+
+    private Type ResolveType(ITypeSymbol typeSymbol, Dictionary<string, Type>? genericParameterMap = null)


Review whether more calls of this should be done while supplying a genericParameterMap. For example, the expression could be referencing a generic type parameter from the containing type.

Yeah, I suspect there are a few bugs lurking around this... With everything going on, I'll defer this to now, and have added a note in #33639. We can fix later based on feedback or do a more thorough review.

AndriySvyryd · 2024-04-20T06:08:43Z

src/EFCore.Design/Query/Internal/LinqToCSharpSyntaxTranslator.cs

+
+                    // If the member isn't declared on the same type as the expression, (e.g. explicit interface implementation), add
+                    // a cast up to the declaring type.
+                    _ when member.Member.DeclaringType is Type declaringType && declaringType != member.Expression.Type


Add a check whether the declaring type is an interface or the member is hidden

Changed to only add the parentheses for interface-declared members - but what do you have in mind for hidden?

It's a corner case, but if the current type hides the member being used then we'd need to add a cast to the declaring type to be sure that the same member is used

Makes sense - added note in #33639.

src/EFCore.Design/Query/Internal/LinqToCSharpSyntaxTranslator.cs

AndriySvyryd · 2024-04-20T07:02:10Z

src/EFCore.Design/Query/Internal/PrecompiledQueryCodeGenerator.cs

+namespace System.Runtime.CompilerServices
+{
+    [AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
+    sealed class InterceptsLocationAttribute : Attribute


Suggested change

sealed class InterceptsLocationAttribute : Attribute

internal sealed class InterceptsLocationAttribute : Attribute

I think it should actually be file-scoped...

AndriySvyryd · 2024-04-20T07:07:55Z

test/EFCore.Design.Tests/Query/CSharpToLinqTranslatorTest.cs

+
+#nullable enable
+
+public class CSharpToLinqTranslatorTest


Consider merging with LinqToCSharpSyntaxTranslatorTest as roundtrip tests

IMHO it leaves things simpler for each test/test class to focus on one component here, given the complexity of the components...

Note also that the scope of each component here is very different - CSharpToLinq only needs to handle expression types supported by the compiler (i.e. only expression stuff, no loops/blocks/try catch), whereas LinqToCSharp needs to in theory handle everything (or at least everything we actually use in our shapers).

AndriySvyryd · 2024-04-20T07:11:57Z

test/EFCore.Design.Tests/Query/CSharpToLinqTranslatorTest.cs

+        => AssertExpression(
+            () => (object)new Blog(),
+            "(object)new CSharpToLinqTranslatorTest.Blog()");
+


Add tests for anonymous type, different closures, nested generics, indexers, records with

Added note in #33639. I hope we get to do a good bash on this before the release, and flush out bugs.

src/EFCore/Properties/CoreStrings.resx

Closes dotnet#31331

roji requested a review from a team March 12, 2024 15:16

roji commented Mar 12, 2024

View reviewed changes

AndriySvyryd reviewed Mar 15, 2024

View reviewed changes

src/EFCore.Design/Query/Internal/PrecompiledQueryCodeGenerator.cs Outdated Show resolved Hide resolved

roji force-pushed the PrecompiledQueries branch 5 times, most recently from d68d249 to 6b20e62 Compare March 25, 2024 22:00

roji force-pushed the PrecompiledQueries branch 4 times, most recently from 165f114 to 53025c3 Compare April 7, 2024 17:30

roji commented Apr 7, 2024

View reviewed changes

roji marked this pull request as ready for review April 7, 2024 17:32

cincuranet reviewed Apr 8, 2024

View reviewed changes

src/EFCore.Design/Properties/DesignStrings.resx Outdated Show resolved Hide resolved

cincuranet reviewed Apr 8, 2024

View reviewed changes

src/EFCore.Design/Query/Internal/CSharpToLinqTranslator.cs Outdated Show resolved Hide resolved

roji force-pushed the PrecompiledQueries branch 5 times, most recently from 185635c to c20e1b4 Compare April 8, 2024 21:13

cincuranet reviewed Apr 9, 2024

View reviewed changes

roji mentioned this pull request Apr 10, 2024

Pregenerate SQL for precompiled queries #33510

Merged

roji force-pushed the PrecompiledQueries branch from f9095d8 to a0349fd Compare April 13, 2024 06:13

roji mentioned this pull request Apr 13, 2024

Introduce liftable constants to shaper to prepare for precompilation #33351

Merged

maumar reviewed Apr 13, 2024

View reviewed changes

src/EFCore/Query/ExpressionPrinter.cs Outdated Show resolved Hide resolved

AndriySvyryd reviewed Apr 19, 2024

View reviewed changes

src/EFCore.Design/Query/Internal/CSharpToLinqTranslator.cs Outdated Show resolved Hide resolved

AndriySvyryd reviewed Apr 19, 2024

View reviewed changes

src/EFCore.Design/Query/Internal/CSharpToLinqTranslator.cs Outdated Show resolved Hide resolved

AndriySvyryd reviewed Apr 20, 2024

View reviewed changes

src/EFCore.Design/Query/Internal/CSharpToLinqTranslator.cs Outdated Show resolved Hide resolved

AndriySvyryd reviewed Apr 20, 2024

View reviewed changes

src/EFCore.Design/Query/Internal/CSharpToLinqTranslator.cs Outdated Show resolved Hide resolved

AndriySvyryd reviewed Apr 20, 2024

View reviewed changes

src/EFCore.Design/Query/Internal/LinqToCSharpSyntaxTranslator.cs Outdated Show resolved Hide resolved

AndriySvyryd reviewed Apr 20, 2024

View reviewed changes

src/EFCore/Properties/CoreStrings.resx Outdated Show resolved Hide resolved

AndriySvyryd approved these changes Apr 20, 2024

View reviewed changes

roji added 2 commits April 29, 2024 19:16

Tiny cleanup of LinqToCSharpSyntaxTranslator

0677c91

Implement precompiled queries

957fbae

Closes dotnet#31331

roji force-pushed the PrecompiledQueries branch from a0349fd to 4eaafe5 Compare April 29, 2024 19:08

Address review comments

8f4ef6d

roji force-pushed the PrecompiledQueries branch from 4eaafe5 to 8f4ef6d Compare April 29, 2024 20:08

roji merged commit ebbc5ee into dotnet:main Apr 29, 2024

roji deleted the PrecompiledQueries branch April 29, 2024 21:03

roji mentioned this pull request Apr 30, 2024

Minor work items left for CSharpToLinqTranslator #33639

Open

13 tasks

halter73 mentioned this pull request Jun 28, 2024

Update Microsoft.CodeAnalysis version to 4.10 #34116

Closed

Varorbc mentioned this pull request Aug 27, 2025

Unexpected Build Time Increase in .NET 9.0 When Using EF Core 9.0 Packages with Large Model Snapshots #36672

Closed

	sealed class InterceptsLocationAttribute : Attribute
	internal sealed class InterceptsLocationAttribute : Attribute

Conversation

roji commented Mar 12, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

roji left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cincuranet commented Apr 8, 2024

Uh oh!

Uh oh!

Uh oh!

roji commented Apr 8, 2024

Uh oh!

azure-pipelines bot commented Apr 8, 2024

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cincuranet Apr 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roji Apr 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

roji Apr 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

roji left a comment •

edited

Loading

cincuranet Apr 9, 2024 •

edited

Loading

roji Apr 30, 2024 •

edited

Loading

roji Apr 29, 2024 •

edited

Loading