-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #69616 from jasonmalinowski/out-of-proc-design-tim…
…e-builds Run design time builds out-of-process
- Loading branch information
Showing
72 changed files
with
876 additions
and
203 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| awaitable | ||
| Refactorings | ||
| Infos |
269 changes: 269 additions & 0 deletions
269
...uageServer/Microsoft.CodeAnalysis.LanguageServer/HostWorkspace/BuildHostProcessManager.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,269 @@ | ||
| // 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. | ||
|
|
||
| using System.Diagnostics; | ||
| using System.Runtime.InteropServices; | ||
| using System.Xml; | ||
| using System.Xml.Linq; | ||
| using Microsoft.CodeAnalysis.Workspaces.MSBuild.BuildHost; | ||
| using Microsoft.Extensions.Logging; | ||
| using Roslyn.Utilities; | ||
| using StreamJsonRpc; | ||
|
|
||
| namespace Microsoft.CodeAnalysis.LanguageServer.HostWorkspace; | ||
|
|
||
| internal sealed class BuildHostProcessManager : IAsyncDisposable | ||
| { | ||
| private readonly ILoggerFactory? _loggerFactory; | ||
| private readonly ILogger? _logger; | ||
| private readonly string? _binaryLogPath; | ||
|
|
||
| private readonly SemaphoreSlim _gate = new(initialCount: 1); | ||
| private readonly Dictionary<BuildHostProcessKind, BuildHostProcess> _processes = new(); | ||
|
|
||
| public BuildHostProcessManager(ILoggerFactory? loggerFactory = null, string? binaryLogPath = null) | ||
| { | ||
| _loggerFactory = loggerFactory; | ||
| _logger = loggerFactory?.CreateLogger<BuildHostProcessManager>(); | ||
| _binaryLogPath = binaryLogPath; | ||
| } | ||
|
|
||
| public async Task<IBuildHost> GetBuildHostAsync(string projectFilePath, CancellationToken cancellationToken) | ||
| { | ||
| var neededBuildHostKind = GetKindForProject(projectFilePath); | ||
|
|
||
| _logger?.LogTrace($"Choosing a build host of type {neededBuildHostKind} for {projectFilePath}"); | ||
|
|
||
| using (await _gate.DisposableWaitAsync(cancellationToken).ConfigureAwait(false)) | ||
| { | ||
| if (!_processes.TryGetValue(neededBuildHostKind, out var buildHostProcess)) | ||
| { | ||
| var process = neededBuildHostKind switch | ||
| { | ||
| BuildHostProcessKind.NetCore => LaunchDotNetCoreBuildHost(), | ||
| BuildHostProcessKind.NetFramework => LaunchDotNetFrameworkBuildHost(), | ||
| _ => throw ExceptionUtilities.UnexpectedValue(neededBuildHostKind) | ||
| }; | ||
|
|
||
| buildHostProcess = new BuildHostProcess(process, _loggerFactory); | ||
| buildHostProcess.Disconnected += BuildHostProcess_Disconnected; | ||
| _processes.Add(neededBuildHostKind, buildHostProcess); | ||
| } | ||
|
|
||
| return buildHostProcess.BuildHost; | ||
| } | ||
| } | ||
|
|
||
| private void BuildHostProcess_Disconnected(object? sender, EventArgs e) | ||
| { | ||
| Contract.ThrowIfNull(sender, $"{nameof(BuildHostProcess)}.{nameof(BuildHostProcess.Disconnected)} was raised with a null sender."); | ||
|
|
||
| Task.Run(async () => | ||
| { | ||
| BuildHostProcess? processToDispose = null; | ||
|
|
||
| using (await _gate.DisposableWaitAsync().ConfigureAwait(false)) | ||
| { | ||
| // Remove it from our map; it's possible it might have already been removed if we had more than one way we observed a disconnect. | ||
| var existingProcess = _processes.SingleOrNull(p => p.Value == sender); | ||
| if (existingProcess.HasValue) | ||
| { | ||
| processToDispose = existingProcess.Value.Value; | ||
| _processes.Remove(existingProcess.Value.Key); | ||
| } | ||
| } | ||
|
|
||
| // Dispose outside of the lock (even though we don't expect much to happen at this point) | ||
| if (processToDispose != null) | ||
| { | ||
| processToDispose.LoggerForProcessMessages?.LogTrace("Process exited."); | ||
| await processToDispose.DisposeAsync(); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| public async ValueTask DisposeAsync() | ||
| { | ||
| foreach (var process in _processes.Values) | ||
| await process.DisposeAsync(); | ||
| } | ||
|
|
||
| private Process LaunchDotNetCoreBuildHost() | ||
| { | ||
| var processStartInfo = new ProcessStartInfo() | ||
| { | ||
| FileName = RuntimeInformation.IsOSPlatform(OSPlatform.Windows) ? "dotnet.exe" : "dotnet", | ||
| }; | ||
|
|
||
| // We need to roll forward to the latest runtime, since the project may be using an SDK (or an SDK required runtime) newer than we ourselves built with. | ||
| // We set the environment variable since --roll-forward LatestMajor doesn't roll forward to prerelease SDKs otherwise. | ||
| processStartInfo.Environment["DOTNET_ROLL_FORWARD_TO_PRERELEASE"] = "1"; | ||
| processStartInfo.ArgumentList.Add("--roll-forward"); | ||
| processStartInfo.ArgumentList.Add("LatestMajor"); | ||
|
|
||
| processStartInfo.ArgumentList.Add(typeof(IBuildHost).Assembly.Location); | ||
|
|
||
| AppendBuildHostCommandLineArgumentsConfigureProcess(processStartInfo); | ||
|
|
||
| var process = Process.Start(processStartInfo); | ||
| Contract.ThrowIfNull(process, "Process.Start failed to launch a process."); | ||
| return process; | ||
| } | ||
|
|
||
| private Process LaunchDotNetFrameworkBuildHost() | ||
| { | ||
| var netFrameworkBuildHost = Path.Combine(Path.GetDirectoryName(typeof(BuildHostProcessManager).Assembly.Location)!, "BuildHost-net472", "Microsoft.CodeAnalysis.Workspaces.MSBuild.BuildHost.exe"); | ||
| Contract.ThrowIfFalse(File.Exists(netFrameworkBuildHost), $"Unable to locate the .NET Framework build host at {netFrameworkBuildHost}"); | ||
|
|
||
| var processStartInfo = new ProcessStartInfo() | ||
| { | ||
| FileName = netFrameworkBuildHost, | ||
| }; | ||
|
|
||
| AppendBuildHostCommandLineArgumentsConfigureProcess(processStartInfo); | ||
|
|
||
| var process = Process.Start(processStartInfo); | ||
| Contract.ThrowIfNull(process, "Process.Start failed to launch a process."); | ||
| return process; | ||
| } | ||
|
|
||
| private void AppendBuildHostCommandLineArgumentsConfigureProcess(ProcessStartInfo processStartInfo) | ||
| { | ||
| if (_binaryLogPath is not null) | ||
| { | ||
| processStartInfo.ArgumentList.Add("--binlog"); | ||
| processStartInfo.ArgumentList.Add(_binaryLogPath); | ||
| } | ||
|
|
||
| // MSBUILD_EXE_PATH is read by MSBuild to find related tasks and targets. We don't want this to be inherited by our build process, or otherwise | ||
| // it might try to load targets that aren't appropriate for the build host. | ||
| processStartInfo.Environment.Remove("MSBUILD_EXE_PATH"); | ||
|
|
||
| processStartInfo.CreateNoWindow = true; | ||
| processStartInfo.UseShellExecute = false; | ||
| processStartInfo.RedirectStandardInput = true; | ||
| processStartInfo.RedirectStandardOutput = true; | ||
| processStartInfo.RedirectStandardError = true; | ||
| } | ||
|
|
||
| private static readonly XmlReaderSettings s_xmlSettings = new() | ||
| { | ||
| DtdProcessing = DtdProcessing.Prohibit, | ||
| }; | ||
|
|
||
| private static BuildHostProcessKind GetKindForProject(string projectFilePath) | ||
| { | ||
| // At the moment we don't have mono support here, so if we're not on Windows, we'll always force to .NET Core. | ||
| if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) | ||
| return BuildHostProcessKind.NetCore; | ||
|
|
||
| // This implements the algorithm as stated in https://github.com/dotnet/project-system/blob/9a761848e0f330a45e349685a266fea00ac3d9c5/docs/opening-with-new-project-system.md; | ||
| // we'll load the XML of the project directly, and inspect for certain elements. | ||
| XDocument document; | ||
|
|
||
| // Read the XML, prohibiting DTD processing due the the usual concerns there. | ||
| using (var fileStream = new FileStream(projectFilePath, FileMode.Open, FileAccess.Read)) | ||
| using (var xmlReader = XmlReader.Create(fileStream, s_xmlSettings)) | ||
| document = XDocument.Load(xmlReader); | ||
|
|
||
| // If we don't have a root, doesn't really matter which. This project is just malformed. | ||
| if (document.Root == null) | ||
| return BuildHostProcessKind.NetCore; | ||
|
|
||
| // Look for SDK attribute on the root | ||
| if (document.Root.Attribute("Sdk") != null) | ||
| return BuildHostProcessKind.NetCore; | ||
|
|
||
| // Look for <Import Sdk=... /> | ||
| if (document.Root.Elements("Import").Attributes("Sdk").Any()) | ||
| return BuildHostProcessKind.NetCore; | ||
|
|
||
| // Look for <Sdk ... /> | ||
| if (document.Root.Elements("Sdk").Any()) | ||
| return BuildHostProcessKind.NetCore; | ||
|
|
||
| // Looking for PropertyGroups that contain TargetFramework or TargetFrameworks nodes | ||
| var propertyGroups = document.Descendants("PropertyGroup"); | ||
| if (propertyGroups.Elements("TargetFramework").Any() || propertyGroups.Elements("TargetFrameworks").Any()) | ||
| return BuildHostProcessKind.NetCore; | ||
|
|
||
| // Nothing that indicates it's an SDK-style project, so use our .NET framework host | ||
| return BuildHostProcessKind.NetFramework; | ||
| } | ||
|
|
||
| private enum BuildHostProcessKind | ||
| { | ||
| NetCore, | ||
| NetFramework | ||
| } | ||
|
|
||
| private sealed class BuildHostProcess : IAsyncDisposable | ||
| { | ||
| private readonly Process _process; | ||
| private readonly JsonRpc _jsonRpc; | ||
|
|
||
| private int _disposed = 0; | ||
|
|
||
| public BuildHostProcess(Process process, ILoggerFactory? loggerFactory) | ||
| { | ||
| LoggerForProcessMessages = loggerFactory?.CreateLogger($"BuildHost PID {process.Id}"); | ||
|
|
||
| _process = process; | ||
|
|
||
| _process.EnableRaisingEvents = true; | ||
| _process.Exited += Process_Exited; | ||
|
|
||
| _process.ErrorDataReceived += Process_ErrorDataReceived; | ||
|
|
||
| var messageHandler = new HeaderDelimitedMessageHandler(sendingStream: _process.StandardInput.BaseStream, receivingStream: _process.StandardOutput.BaseStream, new JsonMessageFormatter()); | ||
|
|
||
| _jsonRpc = new JsonRpc(messageHandler); | ||
| _jsonRpc.StartListening(); | ||
| BuildHost = _jsonRpc.Attach<IBuildHost>(); | ||
|
|
||
| // Call this last so our type is fully constructed before we start firing events | ||
| _process.BeginErrorReadLine(); | ||
| } | ||
|
|
||
| private void Process_Exited(object? sender, EventArgs e) | ||
| { | ||
| Disconnected?.Invoke(this, EventArgs.Empty); | ||
| } | ||
|
|
||
| private void Process_ErrorDataReceived(object sender, DataReceivedEventArgs e) | ||
| { | ||
| if (e.Data is not null) | ||
| LoggerForProcessMessages?.LogTrace($"Message from Process: {e.Data}"); | ||
| } | ||
|
|
||
| public IBuildHost BuildHost { get; } | ||
| public ILogger? LoggerForProcessMessages { get; } | ||
|
|
||
| public event EventHandler? Disconnected; | ||
|
|
||
| public async ValueTask DisposeAsync() | ||
| { | ||
| // Ensure only one thing disposes; while we disconnect the process will go away, which will call us to do this again | ||
| if (Interlocked.CompareExchange(ref _disposed, value: 1, comparand: 0) != 0) | ||
| return; | ||
|
|
||
| // We will call Shutdown in a try/catch; if the process has gone bad it's possible the connection is no longer functioning. | ||
| try | ||
| { | ||
| await BuildHost.ShutdownAsync(); | ||
| _jsonRpc.Dispose(); | ||
|
|
||
| LoggerForProcessMessages?.LogTrace("Process gracefully shut down."); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| LoggerForProcessMessages?.LogError(e, "Exception while shutting down the BuildHost process."); | ||
|
|
||
| // OK, process may have gone bad. | ||
| _process.Kill(); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
Oops, something went wrong.