Automatic LoaderOptimization.SingleDomain (#4187)

* All non-default app domains use LoaderOptimization.SingleDomain

Solves "Loading this assembly would produce a different grant set from other instances" for IIS .Net Framework applications.
__DDVoidMethodType__  injected to mscorlib.
__DDVoidMethodType__.__DDPatchAppDomainSetup__ use reflection-created delegate that calls
OpenTelemetry.AutoInstrumentation.Loader.AppConfigUpdater.ModifyConfig to modify AppDomainSetup by setting LoaderOptimization.SingleDomain.
That method called from AppDomain.CreateDomain and AppDomainManager.CreateDomainHelper.
OpenTelemetry.AutoInstrumentation.Loader.AppConfigUpdater loader assembly loaded from __DDVoidMethodType__ static ctor.
Added helpers: SignatureBuilder and MemberResolver.

* Added installer parameter to skip GAC registration

Added Asp.Net tests without registration assemblies in GAC.
Removed LoaderOptimization=SingleDomain through registry change for ASP.Net tests.

* Removed LoaderOptimization workaround from test dockerfiles

* Code format applied

* Updated test build to produce no-GAC docker images

* Extended  SignatureBuilder by providing semi-safe wrappers

Moved it to be header-only.
Added unit tests for SignatureBuilder.

* Updated change log and documentation

* Removed Troubleshooting link from IIS instrumentation docs

* Fixed accident docker file changes

* Added comment about callers of AppConfigUpdater.ModifyConfig

* Update CHANGELOG.md typo based on review

Co-authored-by: Chris Ventura <[email protected]>

* Smaller cleanups

* Minor names/comments changes based on @zacharycmontoya review

* Fixed formatting

* Make AppConfigUpdater internal

---------

Co-authored-by: Chris Ventura <[email protected]>

Author: iskiselev

CHANGELOG.md

@@ -11,11 +11,16 @@ This component adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.h
 
 - Support for [`Npgsql`](https://www.nuget.org/packages/Npgsql/)
   metrics instrumentation for versions `6.0.0`+.
+- In install script, Install-OpenTelemetryCore accepts optional argument RegisterAssembliesInGAC,
+  which is true by default. When set to false, assemblies would not be installed in GAC.
+- In install script, new function added: Register-AssembliesInGAC. It installs OpenTelemetry assemblies
+  and dependencies in GAC.
 
 ### Changed
 
 - `otel-dotnet-auto-install.sh` now optionally uses `wget` instead of `curl`,
   improving compatibility with `mcr.microsoft.com/dotnet/runtime` Alpine images.
+- Non-default application domains will be forced to load with LoaderOptimization.SingleDomain
 
 #### Dependency updates
 

build/Build.Steps.Windows.cs

@@ -135,7 +135,7 @@ partial class Build
         .Executes(() =>
         {
             var aspNetProject = Solution.GetProjectByName(Projects.Tests.Applications.AspNet);
-            BuildDockerImage(aspNetProject, "integrated", "classic");
+            BuildDockerImage(aspNetProject, "integrated-nogac", "classic-nogac", "integrated", "classic");
 
             var wcfProject = Solution.GetProjectByName(Projects.Tests.Applications.WcfIis);
             BuildDockerImage(wcfProject);

docs/iis-instrumentation.md

@@ -99,7 +99,3 @@ application pool.
 1. Close all external windows and press 'Apply' in the main
    'Configuration Editor' view.
 1. Restart your application.
-
-## Troubleshooting
-
-See [`troubleshooting.md`](troubleshooting.md#iis---loading-this-assembly-would-produce-a-different-grant-set-from-other-instances).

docs/troubleshooting.md

@@ -232,23 +232,3 @@ Sample Diagnostic Output:
 For resolving runtime store assembly version conflicts, follow the same solution
 as outlined for [Assembly version conflicts](#assembly-version-conflicts) in
 this document.
-
-### IIS - Loading this assembly would produce a different grant set from other instances
-
-#### Symptoms
-
-.NET Framework, IIS hosted application crashes and you get an event similar to
-the following:
-
-```log
-Exception: System.IO.FileLoadException
-
-Message: Loading this assembly would produce a different grant set from other instances.
-```
-
-#### Solution
-
-Create a new `DWORD` value called `LoaderOptimization` and give it the value `1`
-under the `HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework`.
-It will allows to load different versions of the same application to different domains.
-It might increase CPU and memory usage.

script-templates/OpenTelemetry.DotNet.Auto.psm1.template

@@ -295,6 +295,36 @@ function Is-Greater-Version($v1, $v2) {
     return $false;
 }
 
+<#
+    .SYNOPSIS
+    Installs OpenTelemetry .NET Assemblies in GAC.
+    .PARAMETER InstallDir
+    Default: <auto> - the default path is Program Files dir.
+    Install path of the OpenTelemetry .NET Automatic Instrumentation
+    Possible values: <auto>, (Custom path)
+#>
+function Register-AssembliesInGAC() {
+    $installDir = Get-Current-InstallDir
+
+    # Register .NET Framework dlls in GAC
+    [System.Reflection.Assembly]::Load("System.EnterpriseServices, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a") | Out-Null
+    $publish = New-Object System.EnterpriseServices.Internal.Publish 
+    $dlls = Get-ChildItem -Path $installDir\netfx\ -Filter *.dll -File
+    for ($i = 0; $i -lt $dlls.Count; $i++) {
+        $percentageComplete = $i / $dlls.Count * 100
+        Write-Progress -Activity "Registering .NET Framework dlls in GAC" `
+            -Status "Module $($i+1) out of $($dlls.Count). Installing $($dlls[$i].Name):" `
+            -PercentComplete $percentageComplete
+
+        if (Test-AssemblyNotForGAC $dlls[$i].Name) {
+            continue
+        }
+
+        $publish.GacInstall($dlls[$i].FullName)
+    }
+    Write-Progress -Activity "Registering .NET Framework dlls in GAC" -Status "Ready" -Completed
+}
+
 <#
     .SYNOPSIS
     Installs OpenTelemetry .NET Automatic Instrumentation.
@@ -308,7 +338,9 @@ function Install-OpenTelemetryCore() {
         [Parameter(Mandatory = $false)]
         [string]$InstallDir = "<auto>",
         [Parameter(Mandatory = $false)]
-        [string]$LocalPath
+        [string]$LocalPath,
+        [Parameter(Mandatory = $false)]
+        [bool]$RegisterAssembliesInGAC = $true
     )
 
     $version = "v{{VERSION}}"
@@ -332,23 +364,9 @@ function Install-OpenTelemetryCore() {
         # OpenTelemetry service locator
         [System.Environment]::SetEnvironmentVariable($ServiceLocatorVariable, $installDir, [System.EnvironmentVariableTarget]::Machine)
 
-        # Register .NET Framework dlls in GAC
-        [System.Reflection.Assembly]::Load("System.EnterpriseServices, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a") | Out-Null
-        $publish = New-Object System.EnterpriseServices.Internal.Publish 
-        $dlls = Get-ChildItem -Path $installDir\netfx\ -Filter *.dll -File
-        for ($i = 0; $i -lt $dlls.Count; $i++) {
-            $percentageComplete = $i / $dlls.Count * 100
-            Write-Progress -Activity "Registering .NET Framework dlls in GAC" `
-                -Status "Module $($i+1) out of $($dlls.Count). Installing $($dlls[$i].Name):" `
-                -PercentComplete $percentageComplete
-
-            if (Test-AssemblyNotForGAC $dlls[$i].Name) {
-                continue
-            }
-
-            $publish.GacInstall($dlls[$i].FullName)
+        if ($RegisterAssembliesInGAC){
+            Register-AssembliesInGAC $installDir
         }
-        Write-Progress -Activity "Registering .NET Framework dlls in GAC" -Status "Ready" -Completed
     } 
     catch {
         $message = $_
@@ -406,7 +424,9 @@ function Uninstall-OpenTelemetryCore() {
 function Update-OpenTelemetryCore() {
     param(
         [Parameter(Mandatory = $false)]
-        [bool]$RegisterIIS = $false
+        [bool]$RegisterIIS = $false,
+        [Parameter(Mandatory = $false)]
+        [bool]$RegisterAssembliesInGAC = $true
     )
 
     $currentInstallVersion = Get-OpenTelemetryInstallVersion
@@ -436,7 +456,7 @@ function Update-OpenTelemetryCore() {
     Remove-Module OpenTelemetry.Dotnet.Auto
     Import-Module $modulePath
 
-    Install-OpenTelemetryCore -InstallDir $installDir
+    Install-OpenTelemetryCore -InstallDir $installDir -RegisterAssembliesInGAC $$RegisterAssembliesInGAC
     if ($RegisterIIS) {
         Register-OpenTelemetryForIIS
     }
@@ -660,3 +680,4 @@ Export-ModuleMember -Function Get-OpenTelemetryInstallDirectory
 Export-ModuleMember -Function Get-OpenTelemetryInstallVersion
 Export-ModuleMember -Function Enable-OpenTelemetryForIISAppPool
 Export-ModuleMember -Function Disable-OpenTelemetryForIISAppPool
+Export-ModuleMember -Function Register-AssembliesInGAC

src/OpenTelemetry.AutoInstrumentation.Loader/AppConfigUpdater.cs

@@ -0,0 +1,24 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+#if NETFRAMEWORK
+namespace OpenTelemetry.AutoInstrumentation.Loader;
+
+/// <summary>
+/// Handles update of config files for non-default AppDomain
+/// </summary>
+internal static class AppConfigUpdater
+{
+    /// <summary>
+    /// Modify assembly bindings in appDomainSetup.
+    /// Will be called through reflection when new <see cref="System.AppDomain"/> created.
+    /// Call done using bytecode modifications for <see cref="AppDomain.CreateDomain(string,System.Security.Policy.Evidence,System.AppDomainSetup)"/>
+    /// and <see cref="AppDomainManager.CreateDomainHelper(string,System.Security.Policy.Evidence,System.AppDomainSetup)"/>.
+    /// </summary>
+    /// <param name="appDomainSetup">appDomainSetup to be updated</param>
+    public static void ModifyConfig(AppDomainSetup appDomainSetup)
+    {
+        appDomainSetup.LoaderOptimization = LoaderOptimization.SingleDomain;
+    }
+}
+#endif

src/OpenTelemetry.AutoInstrumentation.Native/CMakeLists.txt

@@ -177,6 +177,7 @@ add_library("OpenTelemetry.AutoInstrumentation.Native.static" STATIC
         il_rewriter_wrapper.cpp
         il_rewriter.cpp
         integration.cpp
+        member_resolver.cpp
         metadata_builder.cpp
         miniutf.cpp
         string.cpp

src/OpenTelemetry.AutoInstrumentation.Native/OpenTelemetry.AutoInstrumentation.Native.vcxproj

@@ -200,6 +200,7 @@
     <ClInclude Include="logger.h" />
     <ClInclude Include="logger_impl.h" />
     <ClInclude Include="macros.h" />
+    <ClInclude Include="member_resolver.h" />
     <ClInclude Include="metadata_builder.h" />
     <ClInclude Include="method_rewriter.h" />
     <ClInclude Include="miniutf.hpp" />
@@ -211,6 +212,7 @@
     <ClInclude Include="rejit_handler.h" />
     <ClInclude Include="rejit_preprocessor.h" />
     <ClInclude Include="rejit_work_offloader.h" />
+    <ClInclude Include="signature_builder.h" />
     <ClInclude Include="startup_hook.h" />
     <ClInclude Include="stats.h" />
     <ClInclude Include="string.h" />
@@ -230,6 +232,7 @@
     <ClCompile Include="il_rewriter.cpp" />
     <ClCompile Include="il_rewriter_wrapper.cpp" />
     <ClCompile Include="integration.cpp" />
+    <ClCompile Include="member_resolver.cpp" />
     <ClCompile Include="metadata_builder.cpp" />
     <ClCompile Include="method_rewriter.cpp" />
     <ClCompile Include="miniutf.cpp" />