Merge branch 'dotnet:main' into patch-1

Author: kamronbatman

docs/coding-guidelines/source-generator-guidelines.md

@@ -0,0 +1,31 @@
+Recommended reading to better understand source generators,
+[Roslyn Source Generators Cookbook](https://github.com/dotnet/roslyn/blob/main/docs/features/source-generators.cookbook.md).
+
+[Project guidance](./project-guidelines.md#directory-layout)
+
+[Packaging guidance](./libraries-packaging.md#analyzers--source-generators)
+
+## Source Generator Best Practices
+
+### DOs
+
+- **DO** generate code that looks as if a developer would write it manually.
+- **DO** emit strings rather than using the Roslyn Syntax API for better performance.
+- **DO** use consistent indentation and formatting in generated code.
+- **DO** generators should use the [`IIncrementalGenerator`](https://learn.microsoft.com/dotnet/api/microsoft.codeanalysis.iincrementalgenerator) interface.
+- **DO** set `<EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>` in the source generator project and then don't use any of the banned APIs it lists.
+- **DO** set `<IsRoslynComponent>true</IsRoslynComponent>` in the source generator project to enable debugging support in Visual Studio.
+- **DO** disable the following Roslyn warning, `RS2008`, in the source generator project (that is, `<NoWarn>$(NoWarn);RS2008</NoWarn>`). The reported issue is handled differently in the runtime repo.
+- **DO** emit diagnostics from a separate [analyzer](https://learn.microsoft.com/visualstudio/extensibility/getting-started-with-roslyn-analyzers). The analyzer and source generator can be in the same assembly.
+- **DO** cache intermediate results to avoid redundant computation.
+- **DO** consider the impact on build time and optimize accordingly.
+- **DO** have separate projects for testing the generator and testing the code generated by the generator.
+- **DO** use the Roslyn Testing SDK to test the generator (and any corresponding analyzers).
+
+### DON'Ts
+
+- **DON'T** use the Roslyn Syntax API for emitting source code.
+- **DON'T** perform expensive operations during the generation process unless absolutely necessary.
+- **DON'T** emit code that introduces runtime dependencies not explicitly referenced by the project.
+- **DON'T** emit code that would trigger compiler warnings in normal usage scenarios.
+- **DON'T** emit diagnostics from the generator itself, emit them from an [analyzer](https://learn.microsoft.com/visualstudio/extensibility/getting-started-with-roslyn-analyzers).

docs/design/datacontracts/Loader.md

@@ -31,7 +31,12 @@ record struct ModuleLookupTables(
 
 ``` csharp
 ModuleHandle GetModuleHandle(TargetPointer module);
+TargetPointer GetRootAssembly();
 TargetPointer GetAssembly(ModuleHandle handle);
+TargetPointer GetPEAssembly(ModuleHandle handle);
+bool TryGetLoadedImageContents(ModuleHandle handle, out TargetPointer baseAddress, out uint size, out uint imageFlags);
+bool TryGetSymbolStream(ModuleHandle handle, out TargetPointer buffer, out uint size);
+bool IsProbeExtensionResultValid(ModuleHandle handle);
 ModuleFlags GetFlags(ModuleHandle handle);
 string GetPath(ModuleHandle handle);
 string GetFileName(ModuleHandle handle);
@@ -49,12 +54,14 @@ Data descriptors used:
 | Data Descriptor Name | Field | Meaning |
 | --- | --- | --- |
 | `Module` | `Assembly` | Assembly of the Module |
+| `Module` | `PEAssembly` | PEAssembly of the Module |
 | `Module` | `Base` | Pointer to start of PE file in memory |
 | `Module` | `Flags` | Assembly of the Module |
 | `Module` | `LoaderAllocator` | LoaderAllocator of the Module |
 | `Module` | `ThunkHeap` | Pointer to the thunk heap |
 | `Module` | `Path` | Path of the Module (UTF-16, null-terminated) |
 | `Module` | `FileName` | File name of the Module (UTF-16, null-terminated) |
+| `Module` | `GrowableSymbolStream` | Pointer to the in memory symbol stream |
 | `Module` | `FieldDefToDescMap` | Mapping table |
 | `Module` | `ManifestModuleReferencesMap` | Mapping table |
 | `Module` | `MemberRefToDescMap` | Mapping table |
@@ -64,18 +71,92 @@ Data descriptors used:
 | `ModuleLookupMap` | `TableData` | Start of the mapping table's data |
 | `ModuleLookupMap` | `SupportedFlagsMask` | Mask for flag bits on lookup map entries |
 | `ModuleLookupMap` | `Count` | Number of TargetPointer sized entries in this section of the map |
-| `ModuleLookupMap` | `Next` | Pointer to next ModuleLookupMap segment for this map
-| `Assembly` | `IsCollectible` | Flag indicating if this is module may be collected
+| `ModuleLookupMap` | `Next` | Pointer to next ModuleLookupMap segment for this map |
+| `Assembly` | `IsCollectible` | Flag indicating if this is module may be collected |
+| `PEAssembly` | `PEImage` | Pointer to the PEAssembly's PEImage |
+| `PEImage` | `LoadedImageLayout` | Pointer to the PEImage's loaded PEImageLayout |
+| `PEImage` | `ProbeExtensionResult` | PEImage's ProbeExtensionResult |
+| `ProbeExtensionResult` | `Type` | Type of ProbeExtensionResult |
+| `PEImageLayout` | `Base` | Base address of the image layout |
+| `PEImageLayout` | `Size` | Size of the image layout |
+| `PEImageLayout` | `Flags` | Flags associated with the PEImageLayout |
+| `CGrowableSymbolStream` | `Buffer` | Pointer to the raw symbol stream buffer start |
+| `CGrowableSymbolStream` | `Size` | Size of the raw symbol stream buffer |
+| `AppDomain` | `RootAssembly` | Pointer to the root assembly |
+
+Global variables used:
+| Global Name | Type | Purpose |
+| --- | --- | --- |
+| `AppDomain` | TargetPointer | Pointer to the global AppDomain |
+
 
 ``` csharp
 ModuleHandle GetModuleHandle(TargetPointer modulePointer)
 {
     return new ModuleHandle(modulePointer);
 }
 
+TargetPointer GetRootAssembly()
+{
+    TargetPointer appDomainPointer = _target.ReadGlobalPointer(Constants.Globals.AppDomain);
+    AppDomain appDomain = // read AppDomain object starting at appDomainPointer
+    return appDomain.RootAssembly;
+}
+
 TargetPointer GetAssembly(ModuleHandle handle)
 {
-    return target.ReadPointer(handle.Address + /* Module::Assrembly offset */);
+    return target.ReadPointer(handle.Address + /* Module::Assembly offset */);
+}
+
+TargetPointer GetPEAssembly(ModuleHandle handle)
+{
+    return target.ReadPointer(handle.Address + /* Module::PEAssembly offset */);
+}
+
+bool TryGetLoadedImageContents(ModuleHandle handle, out TargetPointer baseAddress, out uint size, out uint imageFlags)
+{
+    baseAddress = TargetPointer.Null;
+    size = 0;
+    imageFlags = 0;
+
+    TargetPointer peAssembly = target.ReadPointer(handle.Address + /* Module::PEAssembly offset */);
+    if (peAssembly == 0) return false; // no loaded PEAssembly
+
+    TargetPointer peImage = target.ReadPointer(peAssembly + /* PEAssembly::PEImage offset */);
+    if(peImage == 0) return false; // no loaded PEImage
+
+    TargetPointer peImageLayout = target.ReadPointer(peImage + /* PEImage::LoadedImageLayout offset */);
+
+    baseAddress = target.ReadPointer(peImageLayout + /* PEImageLayout::Base offset */);
+    size = target.Read<uint>(peImageLayout + /* PEImageLayout::Size offset */);
+    imageFlags = target.Read<uint>(peImageLayout + /* PEImageLayout::Flags offset */);
+    return true;
+}
+
+bool TryGetSymbolStream(ModuleHandle handle, out TargetPointer buffer, out uint size)
+{
+    buffer = TargetPointer.Null;
+    size = 0;
+
+    TargetPointer growableSymbolStream = target.ReadPointer(handle.Address + /* Module::GrowableSymbolStream offset */);
+    if (growableSymbolStream == 0) return false; // no GrowableSymbolStream found
+
+    buffer = target.ReadPointer(growableSymbolStream + /* CGrowableSymbolStream::Buffer offset */);
+    size = target.Read<uint>(growableSymbolStream + /* CGrowableSymbolStream::Size offset */);
+    return true;
+}
+
+bool IsProbeExtensionResultValid(ModuleHandle handle)
+{
+    TargetPointer peAssembly = target.ReadPointer(handle.Address + /* Module::PEAssembly offset */);
+    if (peAssembly == 0) return false; // no loaded PEAssembly
+
+    TargetPointer peImage = target.ReadPointer(peAssembly + /* PEAssembly::PEImage offset */);
+    if(peImage == 0) return false; // no loaded PEImage
+
+    TargetPointer probeExtensionResult = target.ReadPointer(peImage + /* PEImage::ProbeExtensionResult offset */);
+    int type = target.Read<int>(probeExtensionResult + /* ProbeExtensionResult::Type offset */);
+    return type != 0; // 0 is the invalid type. See assemblyprobeextension.h for details
 }
 
 ModuleFlags GetFlags(ModuleHandle handle)

eng/Publishing.props

@@ -86,6 +86,9 @@
     <ShouldGenerateProductVersionFiles Condition="'$(OutputRID)' == 'win-x64' and ('$(DotNetBuildPass)' == '' or '$(DotNetBuildPass)' == '1')">true</ShouldGenerateProductVersionFiles>
     <ShouldGenerateProductVersionFiles Condition="'$(DotNetBuildSourceOnly)' == 'true'">true</ShouldGenerateProductVersionFiles>
   </PropertyGroup>
+  <PropertyGroup Condition="'$(DotNetBuildOrchestrator)' != 'true'">
+    <ShouldGenerateProductVersionFiles Condition="'$(DotNetFinalPublish)' == 'true'">true</ShouldGenerateProductVersionFiles>
+  </PropertyGroup>
 
   <Target Name="GenerateProductVersionFiles"
           DependsOnTargets="GetNonStableProductVersion"

eng/Version.Details.xml

@@ -71,9 +71,9 @@
       <SourceBuild RepoName="emsdk" ManagedOnly="true" />
     </Dependency>
     <!-- Intermediate is necessary for source build. -->
-    <Dependency Name="Microsoft.SourceBuild.Intermediate.source-build-reference-packages" Version="10.0.620402">
+    <Dependency Name="Microsoft.SourceBuild.Intermediate.source-build-reference-packages" Version="10.0.621001">
       <Uri>https://github.com/dotnet/source-build-reference-packages</Uri>
-      <Sha>14f833124983b36ac4083338d0cad6caefce2489</Sha>
+      <Sha>1df7df81ac783e63aa7fbccb0232ad20fb128b15</Sha>
       <SourceBuild RepoName="source-build-reference-packages" ManagedOnly="true" />
     </Dependency>
     <!-- Intermediate is necessary for source build. -->
@@ -376,30 +376,30 @@
       <Uri>https://github.com/dotnet/runtime-assets</Uri>
       <Sha>207b0aac7c32b425a684734a70ba78bfdddb9e48</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.Net.Compilers.Toolset" Version="5.0.0-1.25212.1">
+    <Dependency Name="Microsoft.Net.Compilers.Toolset" Version="5.0.0-1.25214.5">
       <Uri>https://github.com/dotnet/roslyn</Uri>
-      <Sha>65ce1f581703f0c34f81937dcb3dc080bc169c81</Sha>
+      <Sha>959bcb76028fa383d6e1388c60bef630c75470d3</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.CodeAnalysis" Version="5.0.0-1.25212.1">
+    <Dependency Name="Microsoft.CodeAnalysis" Version="5.0.0-1.25214.5">
       <Uri>https://github.com/dotnet/roslyn</Uri>
-      <Sha>65ce1f581703f0c34f81937dcb3dc080bc169c81</Sha>
+      <Sha>959bcb76028fa383d6e1388c60bef630c75470d3</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.CodeAnalysis.CSharp" Version="5.0.0-1.25212.1">
+    <Dependency Name="Microsoft.CodeAnalysis.CSharp" Version="5.0.0-1.25214.5">
       <Uri>https://github.com/dotnet/roslyn</Uri>
-      <Sha>65ce1f581703f0c34f81937dcb3dc080bc169c81</Sha>
+      <Sha>959bcb76028fa383d6e1388c60bef630c75470d3</Sha>
     </Dependency>
-    <Dependency Name="Microsoft.CodeAnalysis.Analyzers" Version="3.12.0-beta1.25212.1">
+    <Dependency Name="Microsoft.CodeAnalysis.Analyzers" Version="3.12.0-beta1.25214.5">
       <Uri>https://github.com/dotnet/roslyn</Uri>
-      <Sha>65ce1f581703f0c34f81937dcb3dc080bc169c81</Sha>
+      <Sha>959bcb76028fa383d6e1388c60bef630c75470d3</Sha>
     </Dependency>
     <Dependency Name="Microsoft.CodeAnalysis.NetAnalyzers" Version="10.0.0-preview.25127.1">
       <Uri>https://github.com/dotnet/roslyn-analyzers</Uri>
       <Sha>345816fb41f40db5463ecc9b4308d29fbc0e4eaf</Sha>
     </Dependency>
     <!-- Intermediate is necessary for source build. -->
-    <Dependency Name="Microsoft.SourceBuild.Intermediate.roslyn" Version="5.0.0-1.25212.1">
+    <Dependency Name="Microsoft.SourceBuild.Intermediate.roslyn" Version="5.0.0-1.25214.5">
       <Uri>https://github.com/dotnet/roslyn</Uri>
-      <Sha>65ce1f581703f0c34f81937dcb3dc080bc169c81</Sha>
+      <Sha>959bcb76028fa383d6e1388c60bef630c75470d3</Sha>
       <SourceBuild RepoName="roslyn" ManagedOnly="true" />
     </Dependency>
     <Dependency Name="Microsoft.DotNet.ApiCompat.Task" Version="10.0.100-preview.3.25173.9">

eng/Versions.props

@@ -36,17 +36,17 @@
   </ItemGroup>
   <PropertyGroup>
     <!-- dotnet/roslyn-analyzers dependencies -->
-    <MicrosoftCodeAnalysisAnalyzersVersion>3.12.0-beta1.25212.1</MicrosoftCodeAnalysisAnalyzersVersion>
+    <MicrosoftCodeAnalysisAnalyzersVersion>3.12.0-beta1.25214.5</MicrosoftCodeAnalysisAnalyzersVersion>
     <MicrosoftCodeAnalysisNetAnalyzersVersion>10.0.0-preview.25127.1</MicrosoftCodeAnalysisNetAnalyzersVersion>
     <!-- dotnet/roslyn dependencies -->
     <!--
       These versions should not be used by any project that contributes to the design-time experience in VS, such as an analyzer, code-fix, or generator assembly.
       Any tools that contribute to the design-time experience should use the MicrosoftCodeAnalysisVersion_LatestVS property above to ensure
       they do not break the local dev experience.
     -->
-    <MicrosoftCodeAnalysisCSharpVersion>5.0.0-1.25212.1</MicrosoftCodeAnalysisCSharpVersion>
-    <MicrosoftCodeAnalysisVersion>5.0.0-1.25212.1</MicrosoftCodeAnalysisVersion>
-    <MicrosoftNetCompilersToolsetVersion>5.0.0-1.25212.1</MicrosoftNetCompilersToolsetVersion>
+    <MicrosoftCodeAnalysisCSharpVersion>5.0.0-1.25214.5</MicrosoftCodeAnalysisCSharpVersion>
+    <MicrosoftCodeAnalysisVersion>5.0.0-1.25214.5</MicrosoftCodeAnalysisVersion>
+    <MicrosoftNetCompilersToolsetVersion>5.0.0-1.25214.5</MicrosoftNetCompilersToolsetVersion>
   </PropertyGroup>
   <!--
     For source generator support we need to target multiple versions of Roslyn in order to be able to run on older versions of Roslyn.

eng/pipelines/runtime-official.yml

@@ -473,7 +473,7 @@ extends:
                 targetFolder: $(Build.SourcesDirectory)/artifacts/workloadPackages
                 flattenFolders: true
 
-            buildArgs: -s mono.workloads -c $(_BuildConfig) -restore -build -publish /p:PackageSource=$(Build.SourcesDirectory)/artifacts/workloadPackages /p:WorkloadOutputPath=$(Build.SourcesDirectory)/artifacts/workloads /p:ShouldGenerateProductVersionFiles=true /p:EnableDefaultRidSpecificArtifacts=false
+            buildArgs: -s mono.workloads -c $(_BuildConfig) -restore -build -publish /p:PackageSource=$(Build.SourcesDirectory)/artifacts/workloadPackages /p:WorkloadOutputPath=$(Build.SourcesDirectory)/artifacts/workloads /p:EnableDefaultRidSpecificArtifacts=false
 
             isOfficialBuild: true
             timeoutInMinutes: 120

eng/pipelines/runtime.yml

@@ -818,6 +818,16 @@ extends:
       #
       # WebAssembly legs
       #
+      - template: /eng/pipelines/common/templates/wasm-library-tests.yml
+        parameters:
+          platforms:
+            - browser_wasm
+          alwaysRun: ${{ variables.isRollingBuild }}
+          extraBuildArgs: /p:AotHostArchitecture=x64 /p:AotHostOS=$(_hostedOS)
+          scenarios:
+            - WasmTestOnChrome
+            - WasmTestOnFirefox
+
       - template: /eng/pipelines/common/templates/wasm-library-tests.yml
         parameters:
           platforms:

eng/testing/linker/project.csproj.template

@@ -53,7 +53,7 @@
     <MicrosoftNetCoreAppRuntimePackDir>{MicrosoftNetCoreAppRuntimePackDir}</MicrosoftNetCoreAppRuntimePackDir>
 
     <RepositoryEngineeringDir>{RepositoryEngineeringDir}</RepositoryEngineeringDir>
-    <_ExtraTrimmerArgs>{ExtraTrimmerArgs} $(_ExtraTrimmerArgs)</_ExtraTrimmerArgs>
+    <_ExtraTrimmerArgs>{ExtraTrimmerArgs} $(_ExtraTrimmerArgs) --dump-dependencies</_ExtraTrimmerArgs>
     {AdditionalProperties}
 
     <!-- Needed for PublishAot -->

src/coreclr/System.Private.CoreLib/src/System/Runtime/ExceptionServices/AsmOffsets.cs

@@ -59,14 +59,14 @@ class AsmOffsets
     public const int OFFSETOF__StackFrameIterator__m_AdjustedControlPC = 0x148;
 #elif TARGET_X86
     public const int OFFSETOF__REGDISPLAY__m_pCurrentContext = 0x4;
-    public const int SIZEOF__StackFrameIterator = 0x3c4;
-    public const int OFFSETOF__StackFrameIterator__m_isRuntimeWrappedExceptions = 0x3b2;
-    public const int OFFSETOF__StackFrameIterator__m_AdjustedControlPC = 0x3c0;
+    public const int SIZEOF__StackFrameIterator = 0x3cc;
+    public const int OFFSETOF__StackFrameIterator__m_isRuntimeWrappedExceptions = 0x3ba;
+    public const int OFFSETOF__StackFrameIterator__m_AdjustedControlPC = 0x3c8;
 #else // TARGET_64BIT
     public const int OFFSETOF__REGDISPLAY__m_pCurrentContext = 0x4;
-    public const int SIZEOF__StackFrameIterator = 0xc4;
-    public const int OFFSETOF__StackFrameIterator__m_isRuntimeWrappedExceptions = 0xb2;
-    public const int OFFSETOF__StackFrameIterator__m_AdjustedControlPC = 0xc0;
+    public const int SIZEOF__StackFrameIterator = 0xcc;
+    public const int OFFSETOF__StackFrameIterator__m_isRuntimeWrappedExceptions = 0xba;
+    public const int OFFSETOF__StackFrameIterator__m_AdjustedControlPC = 0xc8;
 #endif // TARGET_64BIT
 
 #else // DEBUG
@@ -116,14 +116,14 @@ class AsmOffsets
     public const int OFFSETOF__StackFrameIterator__m_AdjustedControlPC = 0x140;
 #elif TARGET_X86
     public const int OFFSETOF__REGDISPLAY__m_pCurrentContext = 0x4;
-    public const int SIZEOF__StackFrameIterator = 0x3bc;
-    public const int OFFSETOF__StackFrameIterator__m_isRuntimeWrappedExceptions = 0x3aa;
-    public const int OFFSETOF__StackFrameIterator__m_AdjustedControlPC = 0x3b8;
+    public const int SIZEOF__StackFrameIterator = 0x3c4;
+    public const int OFFSETOF__StackFrameIterator__m_isRuntimeWrappedExceptions = 0x3b2;
+    public const int OFFSETOF__StackFrameIterator__m_AdjustedControlPC = 0x3c0;
 #else // TARGET_64BIT
     public const int OFFSETOF__REGDISPLAY__m_pCurrentContext = 0x4;
-    public const int SIZEOF__StackFrameIterator = 0xbc;
-    public const int OFFSETOF__StackFrameIterator__m_isRuntimeWrappedExceptions = 0xaa;
-    public const int OFFSETOF__StackFrameIterator__m_AdjustedControlPC = 0xb8;
+    public const int SIZEOF__StackFrameIterator = 0xc4;
+    public const int OFFSETOF__StackFrameIterator__m_isRuntimeWrappedExceptions = 0xb2;
+    public const int OFFSETOF__StackFrameIterator__m_AdjustedControlPC = 0xc0;
 #endif // TARGET_64BIT
 
 #endif // DEBUG