/// <summary> /// Resolves the specified SDK. This method uses concurrent dictionaries for locking per build submission and SDK name. This allows a build to be resolving multiple /// SDKs at once where the first request does the heavy lifting and blocked requests use the cached result. /// </summary> /// <param name="submissionId">The current build submission ID that is resolving an SDK.</param> /// <param name="sdk">The <see cref="SdkReference"/> containing information about the SDK to resolve.</param> /// <param name="loggingContext">The <see cref="LoggingContext"/> to use when logging messages during resolution.</param> /// <param name="sdkReferenceLocation">The <see cref="ElementLocation"/> of the element that referenced the SDK.</param> /// <param name="solutionPath">The full path to the solution, if any, that is being built.</param> /// <param name="projectPath">The full path to the project that referenced the SDK.</param> /// <returns>An <see cref="SdkResult"/> containing information about the SDK if one was resolved, otherwise <code>null</code>.</returns> private SdkResult GetSdkResultAndCache(int submissionId, SdkReference sdk, LoggingContext loggingContext, ElementLocation sdkReferenceLocation, string solutionPath, string projectPath) { ErrorUtilities.VerifyThrowInternalNull(sdk, nameof(sdk)); ErrorUtilities.VerifyThrowInternalNull(loggingContext, nameof(loggingContext)); ErrorUtilities.VerifyThrowInternalNull(sdkReferenceLocation, nameof(sdkReferenceLocation)); SdkResult result; if (Traits.Instance.EscapeHatches.DisableSdkResolutionCache) { result = GetSdkResult(submissionId, sdk, loggingContext, sdkReferenceLocation, solutionPath, projectPath); } else { // Get the dictionary for the specified submission if one is already added otherwise create a new dictionary for the submission. ConcurrentDictionary <string, SdkResult> cached = _cache.GetOrAdd(submissionId, new ConcurrentDictionary <string, SdkResult>(MSBuildNameIgnoreCaseComparer.Default)); /* * Get a cached result if available, otherwise resolve the SDK with the SdkResolverService.Instance. If multiple projects are attempting to resolve * the same SDK, they will all block while the first one resolves. Blocked requests will then get the cached result. This ensures that a single * build submission resolves each unique SDK only one time. */ result = cached.GetOrAdd( sdk.Name, key => GetSdkResult(submissionId, sdk, loggingContext, sdkReferenceLocation, solutionPath, projectPath)); } if (result != null && !SdkResolverService.IsReferenceSameVersion(sdk, result.Version)) { // MSB4240: Multiple versions of the same SDK "{0}" cannot be specified. The SDK version "{1}" already specified by "{2}" will be used and the version "{3}" will be ignored. loggingContext.LogWarning(null, new BuildEventFileInfo(sdkReferenceLocation), "ReferencingMultipleVersionsOfTheSameSdk", sdk.Name, result.Version, result.ElementLocation, sdk.Version); } return(result); }
public override SdkResult ResolveSdk(int submissionId, SdkReference sdk, LoggingContext loggingContext, ElementLocation sdkReferenceLocation, string solutionPath, string projectPath, bool interactive) { SdkResult result; if (Traits.Instance.EscapeHatches.DisableSdkResolutionCache) { result = base.ResolveSdk(submissionId, sdk, loggingContext, sdkReferenceLocation, solutionPath, projectPath, interactive); } else { // Get the dictionary for the specified submission if one is already added otherwise create a new dictionary for the submission. ConcurrentDictionary <string, Lazy <SdkResult> > cached = _cache.GetOrAdd(submissionId, new ConcurrentDictionary <string, Lazy <SdkResult> >(MSBuildNameIgnoreCaseComparer.Default)); /* * Get a Lazy<SdkResult> if available, otherwise create a Lazy<SdkResult> which will resolve the SDK with the SdkResolverService.Instance. If multiple projects are attempting to resolve * the same SDK, they will all get back the same Lazy<SdkResult> which ensures that a single build submission resolves each unique SDK only one time. */ Lazy <SdkResult> resultLazy = cached.GetOrAdd( sdk.Name, key => new Lazy <SdkResult>(() => base.ResolveSdk(submissionId, sdk, loggingContext, sdkReferenceLocation, solutionPath, projectPath, interactive))); // Get the lazy value which will block all waiting threads until the SDK is resolved at least once while subsequent calls get cached results. result = resultLazy.Value; } if (result != null && !SdkResolverService.IsReferenceSameVersion(sdk, result.SdkReference.Version) && !SdkResolverService.IsReferenceSameVersion(sdk, result.Version)) { // MSB4240: Multiple versions of the same SDK "{0}" cannot be specified. The previously resolved SDK version "{1}" from location "{2}" will be used and the version "{3}" will be ignored. loggingContext.LogWarning(null, new BuildEventFileInfo(sdkReferenceLocation), "ReferencingMultipleVersionsOfTheSameSdk", sdk.Name, result.Version, result.ElementLocation, sdk.Version); } return(result); }
public override SdkResult ResolveSdk(int submissionId, SdkReference sdk, LoggingContext loggingContext, ElementLocation sdkReferenceLocation, string solutionPath, string projectPath, bool interactive, bool isRunningInVisualStudio) { bool wasResultCached = true; MSBuildEventSource.Log.OutOfProcSdkResolverServiceRequestSdkPathFromMainNodeStart(submissionId, sdk.Name, solutionPath, projectPath); // Get a cached response if possible, otherwise send the request Lazy <SdkResult> sdkResultLazy = _responseCache.GetOrAdd( sdk.Name, key => new Lazy <SdkResult>(() => { wasResultCached = false; return(RequestSdkPathFromMainNode(submissionId, sdk, loggingContext, sdkReferenceLocation, solutionPath, projectPath, interactive, isRunningInVisualStudio)); })); SdkResult sdkResult = sdkResultLazy.Value; if (sdkResult.Version != null && !SdkResolverService.IsReferenceSameVersion(sdk, sdkResult.Version)) { // MSB4240: Multiple versions of the same SDK "{0}" cannot be specified. The SDK version "{1}" already specified by "{2}" will be used and the version "{3}" will be ignored. loggingContext.LogWarning(null, new BuildEventFileInfo(sdkReferenceLocation), "ReferencingMultipleVersionsOfTheSameSdk", sdk.Name, sdkResult.Version, sdkResult.ElementLocation, sdk.Version); } MSBuildEventSource.Log.OutOfProcSdkResolverServiceRequestSdkPathFromMainNodeStop(submissionId, sdk.Name, solutionPath, projectPath, _lastResponse.Success, wasResultCached); return(sdkResult); }
/// <inheritdoc cref="ISdkResolverService.ResolveSdk"/> public override string ResolveSdk(int submissionId, SdkReference sdk, LoggingContext loggingContext, ElementLocation sdkReferenceLocation, string solutionPath, string projectPath) { // Get a cached response if possible, otherwise send the request SdkResolverResponse response = _responseCache.GetOrAdd( sdk.Name, key => RequestSdkPathFromMainNode(submissionId, sdk, loggingContext, sdkReferenceLocation, solutionPath, projectPath)); if (response.Version != null && !SdkResolverService.IsReferenceSameVersion(sdk, response.Version)) { // MSB4240: Multiple versions of the same SDK "{0}" cannot be specified. The SDK version "{1}" already specified by "{2}" will be used and the version "{3}" will be ignored. loggingContext.LogWarning(null, new BuildEventFileInfo(sdkReferenceLocation), "ReferencingMultipleVersionsOfTheSameSdk", sdk.Name, response.Version, response.ElementLocation, sdk.Version); } return(response.FullPath); }
/// <summary> /// Resolves the specified SDK without caching the result. /// </summary> /// <param name="submissionId">The current build submission ID that is resolving an SDK.</param> /// <param name="sdk">The <see cref="SdkReference"/> containing information about the SDK to resolve.</param> /// <param name="loggingContext">The <see cref="LoggingContext"/> to use when logging messages during resolution.</param> /// <param name="sdkReferenceLocation">The <see cref="ElementLocation"/> of the element that referenced the SDK.</param> /// <param name="solutionPath">The full path to the solution, if any, that is being built.</param> /// <param name="projectPath">The full path to the project that referenced the SDK.</param> /// <returns>An <see cref="SdkResult"/> containing information about the SDK if one was resolved, otherwise <code>null</code>.</returns> private SdkResult GetSdkResult(int submissionId, SdkReference sdk, LoggingContext loggingContext, ElementLocation sdkReferenceLocation, string solutionPath, string projectPath) { SdkResult sdkResult = SdkResolverService.Instance.GetSdkResult(submissionId, sdk, loggingContext, sdkReferenceLocation, solutionPath, projectPath); if (sdkResult != null) { if (!SdkResolverService.IsReferenceSameVersion(sdk, sdkResult.Version)) { // MSB4241: The SDK reference "{0}" version "{1}" was resolved to version "{2}" instead. You could be using a different version than expected if you do not update the referenced version to match. loggingContext.LogWarning(null, new BuildEventFileInfo(sdkReferenceLocation), "SdkResultVersionDifferentThanReference", sdk.Name, sdk.Version, sdkResult.Version); } // Associate the element location of the resolved SDK reference sdkResult.ElementLocation = sdkReferenceLocation; } return(sdkResult); }