Skip to content

Commit

Permalink
Revert "Fix analyzer conflicts on Linux (dotnet#69406)"
Browse files Browse the repository at this point in the history
This reverts commit f7cb1f2.
  • Loading branch information
dibarbet committed Aug 14, 2023
1 parent cab7ff3 commit 49e7e87
Show file tree
Hide file tree
Showing 11 changed files with 125 additions and 235 deletions.
10 changes: 1 addition & 9 deletions docs/Breaking API Changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,12 +87,4 @@ All `SymbolDisplayFormat`s (predefined and user-created) now include parameter n

`IncrementalGeneratorRunStep.Outputs` previously contained `IncrementalStepRunReason.Modified` as `Reason`
when the input to the step was modified in a way that produced a new output.
Now the reason will be reported more accurately as `IncrementalStepRunReason.New`.

# Version 4.8.0

### Changed `Assembly.Location` behavior in non-Windows

The value of `Assembly.Location` previously held the location on disk where an analyzer or source generator was loaded from. This could be either the original location or the shadow copy location. In 4.8 this will be `""` in certain cases when running on non Windows platforms. This is due the compiler server loading assemblies using `AssemblyLoadContext.LoadFromStream` instead of loading from disk.

This could already happen in other load scenarios but this change moves it into mainline build scenarios.
Now the reason will be reported more accurately as `IncrementalStepRunReason.New`.
183 changes: 80 additions & 103 deletions src/Compilers/Core/CodeAnalysisTest/AnalyzerAssemblyLoaderTests.cs

Large diffs are not rendered by default.

24 changes: 8 additions & 16 deletions src/Compilers/Core/CodeAnalysisTest/InvokeUtil.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ namespace Microsoft.CodeAnalysis.UnitTests

public sealed class InvokeUtil
{
public void Exec(ITestOutputHelper testOutputHelper, AssemblyLoadContext compilerContext, AssemblyLoadTestFixture fixture, AnalyzerTestKind kind, string typeName, string methodName)
public void Exec(ITestOutputHelper testOutputHelper, AssemblyLoadContext compilerContext, AssemblyLoadTestFixture fixture, bool shadowLoad, string typeName, string methodName)
{
// Ensure that the test did not load any of the test fixture assemblies into
// the default load context. That should never happen. Assemblies should either
Expand All @@ -46,14 +46,9 @@ public void Exec(ITestOutputHelper testOutputHelper, AssemblyLoadContext compile
var compilerContextCount = compilerContext.Assemblies.Count();

using var tempRoot = new TempRoot();
AnalyzerAssemblyLoader loader = kind switch
{
AnalyzerTestKind.LoadDirect => new DefaultAnalyzerAssemblyLoader(compilerContext, AnalyzerLoadOption.LoadFromDisk),
AnalyzerTestKind.LoadStream => new DefaultAnalyzerAssemblyLoader(compilerContext, AnalyzerLoadOption.LoadFromStream),
AnalyzerTestKind.ShadowLoad => new ShadowCopyAnalyzerAssemblyLoader(compilerContext, tempRoot.CreateDirectory().Path),
_ => throw ExceptionUtilities.Unreachable()
};

AnalyzerAssemblyLoader loader = shadowLoad
? new ShadowCopyAnalyzerAssemblyLoader(compilerContext, tempRoot.CreateDirectory().Path)
: new DefaultAnalyzerAssemblyLoader(compilerContext);
try
{
AnalyzerAssemblyLoaderTests.InvokeTestCode(loader, fixture, typeName, methodName);
Expand Down Expand Up @@ -93,15 +88,12 @@ public void Exec(ITestOutputHelper testOutputHelper, AssemblyLoadContext compile

public sealed class InvokeUtil : MarshalByRefObject
{
public void Exec(ITestOutputHelper testOutputHelper, AssemblyLoadTestFixture fixture, AnalyzerTestKind kind, string typeName, string methodName)
public void Exec(ITestOutputHelper testOutputHelper, AssemblyLoadTestFixture fixture, bool shadowLoad, string typeName, string methodName)
{
using var tempRoot = new TempRoot();
AnalyzerAssemblyLoader loader = kind switch
{
AnalyzerTestKind.LoadDirect => new DefaultAnalyzerAssemblyLoader(),
AnalyzerTestKind.ShadowLoad => new ShadowCopyAnalyzerAssemblyLoader(tempRoot.CreateDirectory().Path),
_ => throw ExceptionUtilities.Unreachable()
};
AnalyzerAssemblyLoader loader = shadowLoad
? new ShadowCopyAnalyzerAssemblyLoader(tempRoot.CreateDirectory().Path)
: new DefaultAnalyzerAssemblyLoader();

try
{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Licensed to the .NET Foundation under one or more agreements.
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

Expand All @@ -11,46 +11,19 @@
using System.IO;
using System.Linq;
using System.Reflection;
using System.Runtime.InteropServices;
using System.Runtime.Loader;

namespace Microsoft.CodeAnalysis
{
internal enum AnalyzerLoadOption
{
/// <summary>
/// Once the assembly path is chosen, load it directly from disk at that location
/// </summary>
LoadFromDisk,

/// <summary>
/// Once the assembly path is chosen, read the contents of disk and load from memory
/// </summary>
/// <remarks>
/// While Windows supports this option it comes with a significant performance penalty due
/// to anti virus scans. It can have a load time of 300-500ms while loading from disk
/// is generally 1-2ms. Use this with caution on Windows.
/// </remarks>
LoadFromStream
}

internal partial class AnalyzerAssemblyLoader
{
private readonly AssemblyLoadContext _compilerLoadContext;
private readonly Dictionary<string, DirectoryLoadContext> _loadContextByDirectory = new Dictionary<string, DirectoryLoadContext>(StringComparer.Ordinal);
private readonly AnalyzerLoadOption _loadOption;

internal AssemblyLoadContext CompilerLoadContext => _compilerLoadContext;
internal AnalyzerLoadOption AnalyzerLoadOption => _loadOption;

internal AnalyzerAssemblyLoader()
: this(null, AnalyzerLoadOption.LoadFromDisk)
internal AnalyzerAssemblyLoader(AssemblyLoadContext? compilerLoadContext = null)
{
}

internal AnalyzerAssemblyLoader(AssemblyLoadContext? compilerLoadContext, AnalyzerLoadOption loadOption)
{
_loadOption = loadOption;
_compilerLoadContext = compilerLoadContext ?? AssemblyLoadContext.GetLoadContext(typeof(AnalyzerAssemblyLoader).GetTypeInfo().Assembly)!;
}

Expand Down Expand Up @@ -132,7 +105,7 @@ public DirectoryLoadContext(string directory, AnalyzerAssemblyLoader loader, Ass
if (_loader.IsAnalyzerDependencyPath(assemblyPath))
{
(_, var loadPath) = _loader.GetAssemblyInfoForPath(assemblyPath);
return loadCore(loadPath);
return LoadFromAssemblyPath(loadPath);
}

// Next prefer registered dependencies from other directories. Ideally this would not
Expand All @@ -141,24 +114,11 @@ public DirectoryLoadContext(string directory, AnalyzerAssemblyLoader loader, Ass
// https://github.com/dotnet/roslyn/issues/56442
if (_loader.GetBestPath(assemblyName) is string bestRealPath)
{
return loadCore(bestRealPath);
return LoadFromAssemblyPath(bestRealPath);
}

// No analyzer registered this dependency. Time to fail
return null;

Assembly loadCore(string assemblyPath)
{
if (_loader.AnalyzerLoadOption == AnalyzerLoadOption.LoadFromDisk)
{
return LoadFromAssemblyPath(assemblyPath);
}
else
{
using var stream = File.Open(assemblyPath, FileMode.Open, FileAccess.Read, FileShare.Read);
return LoadFromStream(stream);
}
}
}

protected override IntPtr LoadUnmanagedDll(string unmanagedDllName)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
using System.IO;
using System.Linq;
using System.Reflection;
using System.Runtime.InteropServices;
using Roslyn.Utilities;

namespace Microsoft.CodeAnalysis
Expand All @@ -18,18 +17,14 @@ internal sealed class DefaultAnalyzerAssemblyLoader : AnalyzerAssemblyLoader
{
#if NETCOREAPP

// Called from a netstandard2.0 project, so need to ensure a parameterless constructor is available.
internal DefaultAnalyzerAssemblyLoader()
: this(null)
{
}

internal DefaultAnalyzerAssemblyLoader(System.Runtime.Loader.AssemblyLoadContext? compilerLoadContext = null, AnalyzerLoadOption loadOption = AnalyzerLoadOption.LoadFromDisk)
: base(compilerLoadContext, loadOption)
{
}

#else

internal DefaultAnalyzerAssemblyLoader()
internal DefaultAnalyzerAssemblyLoader(System.Runtime.Loader.AssemblyLoadContext? compilerLoadContext = null)
: base(compilerLoadContext)
{
}

Expand All @@ -41,42 +36,5 @@ internal DefaultAnalyzerAssemblyLoader()
/// <param name="fullPath"></param>
/// <returns></returns>
protected override string PreparePathToLoad(string fullPath) => fullPath;

/// <summary>
/// Return an <see cref="IAnalyzerAssemblyLoader"/> which does not lock assemblies on disk that is
/// most appropriate for the current platform.
/// </summary>
/// <param name="windowsShadowPath">A shadow copy path will be created on Windows and this value
/// will be the base directory where shadow copy assemblies are stored. </param>
internal static IAnalyzerAssemblyLoader CreateNonLockingLoader(string windowsShadowPath)
{
#if NETCOREAPP
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
// The cost of doing stream based loading on Windows is too expensive and we must continue to
// use the shadow copy loader.
return createShadowLoaderWindows();
}
else
{
return new DefaultAnalyzerAssemblyLoader(loadOption: AnalyzerLoadOption.LoadFromStream);
}
#else
return createShadowLoaderWindows();
#endif

ShadowCopyAnalyzerAssemblyLoader createShadowLoaderWindows()
{
// The shadow copy analyzer should only be created on Windows. To create on Linux we cannot use
// GetTempPath as it's not per-user. Generally there is no need as LoadFromStream achieves the same
// effect
if (!Path.IsPathRooted(windowsShadowPath))
{
throw new ArgumentException("Must be a full path.", nameof(windowsShadowPath));
}

return new ShadowCopyAnalyzerAssemblyLoader(windowsShadowPath);
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -44,23 +44,30 @@ internal sealed class ShadowCopyAnalyzerAssemblyLoader : AnalyzerAssemblyLoader
internal int CopyCount => _assemblyDirectoryId;

#if NETCOREAPP
public ShadowCopyAnalyzerAssemblyLoader(string baseDirectory)
public ShadowCopyAnalyzerAssemblyLoader(string? baseDirectory = null)
: this(null, baseDirectory)
{
}

public ShadowCopyAnalyzerAssemblyLoader(AssemblyLoadContext? compilerLoadContext, string baseDirectory)
: base(compilerLoadContext, AnalyzerLoadOption.LoadFromDisk)
public ShadowCopyAnalyzerAssemblyLoader(AssemblyLoadContext? compilerLoadContext, string? baseDirectory = null)
: base(compilerLoadContext)
#else
public ShadowCopyAnalyzerAssemblyLoader(string baseDirectory)
public ShadowCopyAnalyzerAssemblyLoader(string? baseDirectory = null)
#endif
{
if (baseDirectory is null)
if (baseDirectory != null)
{
throw new ArgumentNullException(nameof(baseDirectory));
_baseDirectory = baseDirectory;
}
else
{
// https://github.com/dotnet/roslyn/issues/65415
// Fixing that issue will involve removing this GetTempPath call
#pragma warning disable RS0030
_baseDirectory = Path.Combine(Path.GetTempPath(), "CodeAnalysis", "AnalyzerShadowCopies");
#pragma warning restore RS0030
}

_baseDirectory = baseDirectory;
_shadowCopyDirectoryAndMutex = new Lazy<(string directory, Mutex)>(
() => CreateUniqueDirectoryForProcess(), LazyThreadSafetyMode.ExecutionAndPublication);

Expand Down
3 changes: 1 addition & 2 deletions src/Compilers/Server/VBCSCompiler/CompilerRequestHandler.cs
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public RunRequest(Guid requestId, string language, string? workingDirectory, str

internal sealed class CompilerServerHost : ICompilerServerHost
{
public IAnalyzerAssemblyLoader AnalyzerAssemblyLoader { get; }
public IAnalyzerAssemblyLoader AnalyzerAssemblyLoader { get; } = new ShadowCopyAnalyzerAssemblyLoader(baseDirectory: Path.Combine(Path.GetTempPath(), "VBCSCompiler", "AnalyzerAssemblyLoader"));

public static Func<string, MetadataReferenceProperties, PortableExecutableReference> SharedAssemblyReferenceProvider { get; } = (path, properties) => new CachingMetadataReference(path, properties);

Expand Down Expand Up @@ -72,7 +72,6 @@ internal CompilerServerHost(string clientDirectory, string? sdkDirectory, ICompi
ClientDirectory = clientDirectory;
SdkDirectory = sdkDirectory;
Logger = logger;
AnalyzerAssemblyLoader = DefaultAnalyzerAssemblyLoader.CreateNonLockingLoader(Path.Combine(Path.GetTempPath(), "VBCSCompiler", "AnalyzerAssemblyLoader"));
}

public bool TryCreateCompiler(in RunRequest request, BuildPaths buildPaths, [NotNullWhen(true)] out CommonCompiler? compiler)
Expand Down
10 changes: 10 additions & 0 deletions src/Compilers/Shared/BuildServerConnection.cs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,16 @@ internal sealed class BuildServerConnection
/// <summary>
/// Create a build request for processing on the server.
/// </summary>
/// <remarks>
/// Even though compilation itself does not specifically require a temporary directory to be successful
/// this API deliberately requires <paramref name="tempDirectory"/> to have a value. The reason for this is
/// that the server itself requires a temporary directory to startup and it uses the same logic as the client
/// to calculate it.
///
/// That means if the client can't calculate the temporary directory the server won't be able to either and
/// hence won't be able to start. So creating <see cref="BuildRequest"/> instances isn't useful cause it's
/// wasting time trying to start a server that won't be able to start.
/// </remarks>
internal static BuildRequest CreateBuildRequest(
Guid requestId,
RequestLanguage language,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,14 @@
// See the LICENSE file in the project root for more information.

using Microsoft.CodeAnalysis.Diagnostics;
using System.IO;

namespace Microsoft.CodeAnalysis.ExternalAccess.OmniSharp.Analyzers
{
internal static class OmnisharpAnalyzerAssemblyLoaderFactory
{
public static IAnalyzerAssemblyLoader CreateShadowCopyAnalyzerAssemblyLoader(string? baseDirectory = null)
{
baseDirectory ??= Path.Combine(Path.GetTempPath(), "CodeAnalysis", "OmnisharpAnalyzerShadowCopies");
return DefaultAnalyzerAssemblyLoader.CreateNonLockingLoader(baseDirectory);
return new ShadowCopyAnalyzerAssemblyLoader(baseDirectory);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

using System;
using System.Composition;
using System.IO;
using Microsoft.CodeAnalysis.Host.Mef;

namespace Microsoft.CodeAnalysis.Host
Expand All @@ -13,9 +12,8 @@ namespace Microsoft.CodeAnalysis.Host
[ExportWorkspaceService(typeof(IAnalyzerAssemblyLoaderProvider))]
internal sealed class DefaultAnalyzerAssemblyLoaderService : IAnalyzerAssemblyLoaderProvider
{
private readonly IAnalyzerAssemblyLoader _loader = new DefaultAnalyzerAssemblyLoader();
private readonly IAnalyzerAssemblyLoader _shadowCopyLoader = DefaultAnalyzerAssemblyLoader.CreateNonLockingLoader(
Path.Combine(Path.GetTempPath(), "CodeAnalysis", "WorkspacesAnalyzerShadowCopies"));
private readonly DefaultAnalyzerAssemblyLoader _loader = new();
private readonly ShadowCopyAnalyzerAssemblyLoader _shadowCopyLoader = new();

[ImportingConstructor]
[Obsolete(MefConstruction.ImportingConstructorMessage, error: true)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ internal sealed class RemoteAnalyzerAssemblyLoader : AnalyzerAssemblyLoader

public RemoteAnalyzerAssemblyLoader(string baseDirectory)
{
// jason should we load from stream here on Linux or is this VS only?
_baseDirectory = baseDirectory;
}

Expand Down

0 comments on commit 49e7e87

Please sign in to comment.