admin/PowerShell-PowerShell
1
0
Fork 0
mirror of https://github.com/PowerShell/PowerShell synced 2026-06-08 12:12:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up code regarding AppDomain.CreateDomain and AppDomain.Unload (#15554)

Browse Source
This commit is contained in:
Dongbo Wang
2021-06-10 09:16:05 -07:00
committed by GitHub
parent 6e73c2d4f6
commit e2ee8e7e1f
6 changed files with 115 additions and 394 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/System.Management.Automation/engine/CommandCompletion/CommandCompletion.cs
+55 -67
View File
@@ -526,74 +526,70 @@ namespace System.Management.Automation
{
var context = LocalPipeline.GetExecutionContextFromTLS();
bool cleanupModuleAnalysisAppDomain = context.TakeResponsibilityForModuleAnalysisAppDomain();
// First, check if a V1/V2 implementation of TabExpansion exists. If so, the user had overridden
// the built-in version, so we should continue to use theirs.
int replacementIndex = -1;
int replacementLength = -1;
List<CompletionResult> results = null;
try
if (NeedToInvokeLegacyTabExpansion(powershell))
{
// First, check if a V1/V2 implementation of TabExpansion exists. If so, the user had overridden
// the built-in version, so we should continue to use theirs.
int replacementIndex = -1;
int replacementLength = -1;
List<CompletionResult> results = null;
var inputAndCursor = GetInputAndCursorFromAst(positionOfCursor);
results = InvokeLegacyTabExpansion(powershell, inputAndCursor.Item1, inputAndCursor.Item2, false, out replacementIndex, out replacementLength);
replacementIndex += inputAndCursor.Item3;
}
if (NeedToInvokeLegacyTabExpansion(powershell))
if (results == null || results.Count == 0)
{
/* BROKEN code commented out, fix sometime
// If we were invoked from TabExpansion2, we want to "remove" TabExpansion2 and anything it calls
// from our results. We do this by faking out the session so that TabExpansion2 isn't anywhere to be found.
MutableTuple tupleForFrameToSkipPast = null;
foreach (var stackEntry in context.Debugger.GetCallStack())
{
var inputAndCursor = GetInputAndCursorFromAst(positionOfCursor);
results = InvokeLegacyTabExpansion(powershell, inputAndCursor.Item1, inputAndCursor.Item2, false, out replacementIndex, out replacementLength);
replacementIndex += inputAndCursor.Item3;
dynamic stackEntryAsPSObj = PSObject.AsPSObject(stackEntry);
if (stackEntryAsPSObj.Command.Equals("TabExpansion2", StringComparison.OrdinalIgnoreCase))
{
tupleForFrameToSkipPast = stackEntry.FunctionContext._localsTuple;
break;
}
}
if (results == null || results.Count == 0)
SessionStateScope scopeToRestore = null;
if (tupleForFrameToSkipPast != null)
{
/* BROKEN code commented out, fix sometime
// If we were invoked from TabExpansion2, we want to "remove" TabExpansion2 and anything it calls
// from our results. We do this by faking out the session so that TabExpansion2 isn't anywhere to be found.
MutableTuple tupleForFrameToSkipPast = null;
foreach (var stackEntry in context.Debugger.GetCallStack())
// Find this tuple in the scope stack.
scopeToRestore = context.EngineSessionState.CurrentScope;
var scope = context.EngineSessionState.CurrentScope;
while (scope != null && scope.LocalsTuple != tupleForFrameToSkipPast)
{
dynamic stackEntryAsPSObj = PSObject.AsPSObject(stackEntry);
if (stackEntryAsPSObj.Command.Equals("TabExpansion2", StringComparison.OrdinalIgnoreCase))
{
tupleForFrameToSkipPast = stackEntry.FunctionContext._localsTuple;
break;
}
scope = scope.Parent;
}
SessionStateScope scopeToRestore = null;
if (tupleForFrameToSkipPast != null)
if (scope != null)
{
// Find this tuple in the scope stack.
scopeToRestore = context.EngineSessionState.CurrentScope;
var scope = context.EngineSessionState.CurrentScope;
while (scope != null && scope.LocalsTuple != tupleForFrameToSkipPast)
{
scope = scope.Parent;
}
if (scope != null)
{
context.EngineSessionState.CurrentScope = scope.Parent;
}
context.EngineSessionState.CurrentScope = scope.Parent;
}
try
{
*/
var completionAnalysis = new CompletionAnalysis(ast, tokens, positionOfCursor, options);
results = completionAnalysis.GetResults(powershell, out replacementIndex, out replacementLength);
/*
}
finally
{
if (scopeToRestore != null)
{
context.EngineSessionState.CurrentScope = scopeToRestore;
}
}
*/
}
var completionResults = results ?? EmptyCompletionResult;
try
{
*/
var completionAnalysis = new CompletionAnalysis(ast, tokens, positionOfCursor, options);
results = completionAnalysis.GetResults(powershell, out replacementIndex, out replacementLength);
/*
}
finally
{
if (scopeToRestore != null)
{
context.EngineSessionState.CurrentScope = scopeToRestore;
}
}
*/
}
var completionResults = results ?? EmptyCompletionResult;
#if LEGACYTELEMETRY
// no telemetry here. We don't capture tab completion performance.
@@ -601,19 +597,11 @@ namespace System.Management.Automation
TelemetryAPI.ReportTabCompletionTelemetry(sw.ElapsedMilliseconds, completionResults.Count,
completionResults.Count > 0 ? completionResults[0].ResultType : CompletionResultType.Text);
#endif
return new CommandCompletion(
new Collection<CompletionResult>(completionResults),
-1,
replacementIndex,
replacementLength);
}
finally
{
if (cleanupModuleAnalysisAppDomain)
{
context.ReleaseResponsibilityForModuleAnalysisAppDomain();
}
}
return new CommandCompletion(
new Collection<CompletionResult>(completionResults),
-1,
replacementIndex,
replacementLength);
}
}
src/System.Management.Automation/engine/CommandDiscovery.cs
-7
View File
@@ -1053,7 +1053,6 @@ namespace System.Management.Automation
if (etwEnabled) CommandDiscoveryEventSource.Log.ModuleAutoDiscoveryStart(commandName);
CommandInfo result = null;
bool cleanupModuleAnalysisAppDomain = false;
try
{
// If commandName had a slash, it was module-qualified or path-qualified.
@@ -1076,8 +1075,6 @@ namespace System.Management.Automation
discoveryTracer.WriteLine("Executing non module-qualified search: {0}", commandName);
context.CommandDiscovery.RegisterLookupCommandInfoAction("ActiveModuleSearch", commandName);
cleanupModuleAnalysisAppDomain = context.TakeResponsibilityForModuleAnalysisAppDomain();
// Get the available module files, preferring modules from $PSHOME so that user modules don't
// override system modules during auto-loading
if (etwEnabled) CommandDiscoveryEventSource.Log.SearchingForModuleFilesStart();
@@ -1142,10 +1139,6 @@ namespace System.Management.Automation
finally
{
context.CommandDiscovery.UnregisterLookupCommandInfoAction("ActiveModuleSearch", commandName);
if (cleanupModuleAnalysisAppDomain)
{
context.ReleaseResponsibilityForModuleAnalysisAppDomain();
}
}
if (etwEnabled) CommandDiscoveryEventSource.Log.ModuleAutoDiscoveryStop(commandName);
src/System.Management.Automation/engine/ExecutionContext.cs
-34
View File
@@ -205,40 +205,6 @@ namespace System.Management.Automation
/// </summary>
internal string ModuleBeingProcessed { get; set; }
private bool _responsibilityForModuleAnalysisAppDomainOwned;
internal bool TakeResponsibilityForModuleAnalysisAppDomain()
{
if (_responsibilityForModuleAnalysisAppDomainOwned)
{
return false;
}
Diagnostics.Assert(AppDomainForModuleAnalysis == null, "Invalid module analysis app domain state");
_responsibilityForModuleAnalysisAppDomainOwned = true;
return true;
}
internal void ReleaseResponsibilityForModuleAnalysisAppDomain()
{
Diagnostics.Assert(_responsibilityForModuleAnalysisAppDomainOwned, "Invalid module analysis app domain state");
if (AppDomainForModuleAnalysis != null)
{
AppDomain.Unload(AppDomainForModuleAnalysis);
AppDomainForModuleAnalysis = null;
}
_responsibilityForModuleAnalysisAppDomainOwned = false;
}
/// <summary>
/// The AppDomain currently being used for module analysis. It should only be created if needed,
/// but various callers need to take responsibility for unloading the domain via
/// the TakeResponsibilityForModuleAnalysisAppDomain.
/// </summary>
internal AppDomain AppDomainForModuleAnalysis { get; set; }
/// <summary>
/// Authorization manager for this runspace.
/// </summary>
src/System.Management.Automation/engine/Modules/ImportModuleCommand.cs
-1
View File
@@ -589,7 +589,6 @@ namespace Microsoft.PowerShell.Commands
if (!moduleLoaded)
{
PSModuleInfo module = LoadBinaryModule(
trySnapInName: false,
moduleName: null,
fileName: null,
suppliedAssembly,
src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs
+55 -285
View File
@@ -878,7 +878,6 @@ namespace Microsoft.PowerShell.Commands
// At this point, we are already exhaust all possible ways to load the nested module. The last option is to load it as a binary module/snapin.
module = LoadBinaryModule(
parentModule,
trySnapInName: true,
moduleSpecification.Name,
fileName: null,
assemblyToLoad: null,
@@ -1056,35 +1055,27 @@ namespace Microsoft.PowerShell.Commands
{
IEnumerable<PSModuleInfo> allModules = null;
HashSet<string> modulePathSet = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
bool cleanupModuleAnalysisAppDomain = Context.TakeResponsibilityForModuleAnalysisAppDomain();
try
foreach (string path in ModuleIntrinsics.GetModulePath(false, Context))
{
foreach (string path in ModuleIntrinsics.GetModulePath(false, Context))
string uniquePath = path.TrimEnd(Utils.Separators.Directory);
// Ignore repeated module path.
if (!modulePathSet.Add(uniquePath))
{
string uniquePath = path.TrimEnd(Utils.Separators.Directory);
// Ignore repeated module path.
if (!modulePathSet.Add(uniquePath)) { continue; }
try
{
IEnumerable<PSModuleInfo> modulesFound = GetModulesFromOneModulePath(
names, uniquePath, all, refresh).OrderBy(static m => m.Name);
allModules = allModules == null ? modulesFound : allModules.Concat(modulesFound);
}
catch (Exception e) when (e is IOException || e is UnauthorizedAccessException)
{
// ignore directories that can't be accessed
continue;
}
continue;
}
}
finally
{
if (cleanupModuleAnalysisAppDomain)
try
{
Context.ReleaseResponsibilityForModuleAnalysisAppDomain();
IEnumerable<PSModuleInfo> modulesFound = GetModulesFromOneModulePath(
names, uniquePath, all, refresh).OrderBy(static m => m.Name);
allModules = allModules == null ? modulesFound : allModules.Concat(modulesFound);
}
catch (Exception e) when (e is IOException || e is UnauthorizedAccessException)
{
// ignore directories that can't be accessed
continue;
}
}
@@ -5892,7 +5883,6 @@ namespace Microsoft.PowerShell.Commands
ext.Equals(StringLiterals.PowerShellILExecutableExtension, StringComparison.OrdinalIgnoreCase))
{
module = LoadBinaryModule(
trySnapInName: false,
ModuleIntrinsics.GetModuleName(fileName),
fileName,
assemblyToLoad: null,
@@ -6117,7 +6107,6 @@ namespace Microsoft.PowerShell.Commands
private static readonly Dictionary<string, Tuple<BinaryAnalysisResult, Version>> s_binaryAnalysisCache =
new Dictionary<string, Tuple<BinaryAnalysisResult, Version>>();
#if CORECLR
/// <summary>
/// Analyze the module assembly to find out all cmdlets and aliases defined in that assembly.
/// </summary>
@@ -6157,155 +6146,6 @@ namespace Microsoft.PowerShell.Commands
return resultToReturn;
}
#else
/// <summary>
/// Analyze the module assembly to find out all cmdlets and aliases defined in that assembly.
/// </summary>
private BinaryAnalysisResult GetCmdletsFromBinaryModuleImplementation(string path, ManifestProcessingFlags manifestProcessingFlags, out Version assemblyVersion)
{
Tuple<BinaryAnalysisResult, Version> tuple = null;
lock (s_lockObject)
{
s_binaryAnalysisCache.TryGetValue(path, out tuple);
}
if (tuple != null)
{
assemblyVersion = tuple.Item2;
return tuple.Item1;
}
assemblyVersion = new Version("0.0.0.0");
bool cleanupModuleAnalysisAppDomain = false;
AppDomain tempDomain = Context.AppDomainForModuleAnalysis;
if (tempDomain == null)
{
cleanupModuleAnalysisAppDomain = Context.TakeResponsibilityForModuleAnalysisAppDomain();
tempDomain = Context.AppDomainForModuleAnalysis = AppDomain.CreateDomain("ReflectionDomain");
}
try
{
// create temp appdomain if one is not passed in
tempDomain.SetData("PathToProcess", path);
tempDomain.SetData("IsModuleLoad", 0 != (manifestProcessingFlags & ManifestProcessingFlags.LoadElements));
// reset DetectedCmdlets and AssemblyVersion from previous invocation
tempDomain.SetData("DetectedCmdlets", null);
tempDomain.SetData("DetectedAliases", null);
tempDomain.SetData("AssemblyVersion", assemblyVersion);
tempDomain.DoCallBack(AnalyzeSnapinDomainHelper);
List<string> detectedCmdlets = (List<string>)tempDomain.GetData("DetectedCmdlets");
List<Tuple<string, string>> detectedAliases = (List<Tuple<string, string>>)tempDomain.GetData("DetectedAliases");
assemblyVersion = (Version)tempDomain.GetData("AssemblyVersion");
if ((detectedCmdlets.Count == 0) && (System.IO.Path.IsPathRooted(path)))
{
// If we couldn't load it from a file, try loading from the GAC
string assemblyname = Path.GetFileName(path);
BinaryAnalysisResult gacResult = GetCmdletsFromBinaryModuleImplementation(assemblyname, manifestProcessingFlags, out assemblyVersion);
detectedCmdlets = gacResult.DetectedCmdlets;
detectedAliases = gacResult.DetectedAliases;
}
BinaryAnalysisResult result = new BinaryAnalysisResult();
result.DetectedCmdlets = detectedCmdlets;
result.DetectedAliases = detectedAliases;
lock (s_lockObject)
{
s_binaryAnalysisCache[path] = Tuple.Create(result, assemblyVersion);
}
return result;
}
finally
{
if (cleanupModuleAnalysisAppDomain)
{
Context.ReleaseResponsibilityForModuleAnalysisAppDomain();
}
}
}
private static void AnalyzeSnapinDomainHelper()
{
string path = (string)AppDomain.CurrentDomain.GetData("PathToProcess");
bool isModuleLoad = (bool)AppDomain.CurrentDomain.GetData("IsModuleLoad");
Dictionary<string, SessionStateCmdletEntry> cmdlets = null;
Dictionary<string, List<SessionStateAliasEntry>> aliases = null;
Dictionary<string, SessionStateProviderEntry> providers = null;
string throwAwayHelpFile = null;
Version assemblyVersion = new Version("0.0.0.0");
try
{
Assembly assembly = null;
try
{
// If this is a fully-qualified search, load it from the file
if (Path.IsPathRooted(path))
{
assembly = InitialSessionState.LoadAssemblyFromFile(path);
}
else
{
// Otherwise, load it from the GAC
Exception ignored = null;
assembly = ExecutionContext.LoadAssembly(path, null, out ignored);
}
if (assembly != null)
{
assemblyVersion = GetAssemblyVersionNumber(assembly);
}
}
// Catch-all OK, analyzing user code.
catch (Exception)
{
}
if (assembly != null)
{
PSSnapInHelpers.AnalyzePSSnapInAssembly(assembly, assembly.Location, null, null, isModuleLoad, out cmdlets, out aliases, out providers, out throwAwayHelpFile);
}
}
// Catch-all OK, analyzing user code.
catch (Exception)
{
}
List<string> detectedCmdlets = new List<string>();
List<Tuple<string, string>> detectedAliases = new List<Tuple<string, string>>();
if (cmdlets != null)
{
foreach (SessionStateCmdletEntry cmdlet in cmdlets.Values)
{
detectedCmdlets.Add(cmdlet.Name);
}
}
if (aliases != null)
{
foreach (List<SessionStateAliasEntry> aliasList in aliases.Values)
{
foreach (SessionStateAliasEntry alias in aliasList)
{
detectedAliases.Add(new Tuple<string, string>(alias.Name, alias.Definition));
}
}
}
AppDomain.CurrentDomain.SetData("DetectedCmdlets", detectedCmdlets);
AppDomain.CurrentDomain.SetData("DetectedAliases", detectedAliases);
AppDomain.CurrentDomain.SetData("AssemblyVersion", assemblyVersion);
}
#endif
// Analyzes a script module implementation for its exports.
private static readonly Dictionary<string, PSModuleInfo> s_scriptAnalysisCache = new Dictionary<string, PSModuleInfo>();
@@ -6524,7 +6364,6 @@ namespace Microsoft.PowerShell.Commands
/// <summary>
/// Load a binary module. A binary module is an assembly that should contain cmdlets.
/// </summary>
/// <param name="trySnapInName">If true, then the registered snapins will also be searched when loading.</param>
/// <param name="moduleName">The name of the snapin or assembly to load.</param>
/// <param name="fileName">The path to the assembly to load.</param>
/// <param name="assemblyToLoad">The assembly to load so no lookup need be done.</param>
@@ -6542,7 +6381,6 @@ namespace Microsoft.PowerShell.Commands
/// <param name="found">Sets this to true if an assembly was found.</param>
/// <returns>THe module info object that was created...</returns>
internal PSModuleInfo LoadBinaryModule(
bool trySnapInName,
string moduleName,
string fileName,
Assembly assemblyToLoad,
@@ -6557,7 +6395,6 @@ namespace Microsoft.PowerShell.Commands
{
return LoadBinaryModule(
parentModule: null,
trySnapInName,
moduleName,
fileName,
assemblyToLoad,
@@ -6577,7 +6414,6 @@ namespace Microsoft.PowerShell.Commands
/// Load a binary module. A binary module is an assembly that should contain cmdlets.
/// </summary>
/// <param name="parentModule">The parent module for which this module is a nested module.</param>
/// <param name="trySnapInName">If true, then the registered snapins will also be searched when loading.</param>
/// <param name="moduleName">The name of the snapin or assembly to load.</param>
/// <param name="fileName">The path to the assembly to load.</param>
/// <param name="assemblyToLoad">The assembly to load so no lookup need be done.</param>
@@ -6598,7 +6434,6 @@ namespace Microsoft.PowerShell.Commands
/// <returns>THe module info object that was created...</returns>
internal PSModuleInfo LoadBinaryModule(
PSModuleInfo parentModule,
bool trySnapInName,
string moduleName,
string fileName,
Assembly assemblyToLoad,
@@ -6624,7 +6459,6 @@ namespace Microsoft.PowerShell.Commands
List<Tuple<string, string>> detectedAliases = null;
Assembly assembly = null;
Exception error = null;
bool importSuccessful = false;
string modulePath = string.Empty;
Version assemblyVersion = new Version(0, 0, 0, 0);
var importingModule = (manifestProcessingFlags & ManifestProcessingFlags.LoadElements) != 0;
@@ -6675,114 +6509,50 @@ namespace Microsoft.PowerShell.Commands
}
}
}
else if (importingModule)
{
assembly = Context.AddAssembly(moduleName, fileName, out error);
if (assembly == null)
{
if (error != null)
throw error;
found = false;
return null;
}
assemblyVersion = GetAssemblyVersionNumber(assembly);
if (string.IsNullOrEmpty(fileName))
modulePath = assembly.Location;
else
modulePath = fileName;
// Passing module as a parameter here so that the providers can have the module property populated.
// For engine providers, the module should point to top-level module name
// For FileSystem, the module is Microsoft.PowerShell.Core and not System.Management.Automation
if (parentModule != null && InitialSessionState.IsEngineModule(parentModule.Name))
{
iss.ImportCmdletsFromAssembly(assembly, parentModule);
}
else
{
iss.ImportCmdletsFromAssembly(assembly, null);
}
}
else
{
// Avoid trying to import a PowerShell assembly as Snapin as it results in PSArgumentException
if ((moduleName != null) && Utils.IsPowerShellAssembly(moduleName))
string binaryPath = fileName;
modulePath = fileName;
if (binaryPath == null)
{
trySnapInName = false;
binaryPath = System.IO.Path.Combine(moduleBase, moduleName);
}
if (trySnapInName && PSSnapInInfo.IsPSSnapinIdValid(moduleName))
{
PSSnapInInfo snapin = null;
#if !CORECLR
// Avoid trying to load SnapIns with Import-Module
PSSnapInException warning;
try
{
if (importingModule)
{
snapin = iss.ImportPSSnapIn(moduleName, out warning);
}
}
catch (PSArgumentException)
{
// BUGBUG - brucepay - probably want to have a verbose message here...
}
#endif
if (snapin != null)
{
importSuccessful = true;
if (string.IsNullOrEmpty(fileName))
modulePath = snapin.AbsoluteModulePath;
else
modulePath = fileName;
assemblyVersion = snapin.Version;
// If we're not supposed to load the types files from the snapin
// clear the iss member
if (!loadTypes)
{
iss.Types.Reset();
}
// If we're not supposed to load the format files from the snapin,
// clear the iss member
if (!loadFormats)
{
iss.Formats.Reset();
}
foreach (var a in ClrFacade.GetAssemblies())
{
if (a.GetName().FullName.Equals(snapin.AssemblyName, StringComparison.Ordinal))
{
assembly = a;
break;
}
}
}
}
if (!importSuccessful)
{
if (importingModule)
{
assembly = Context.AddAssembly(moduleName, fileName, out error);
if (assembly == null)
{
if (error != null)
throw error;
found = false;
return null;
}
assemblyVersion = GetAssemblyVersionNumber(assembly);
if (string.IsNullOrEmpty(fileName))
modulePath = assembly.Location;
else
modulePath = fileName;
// Passing module as a parameter here so that the providers can have the module property populated.
// For engine providers, the module should point to top-level module name
// For FileSystem, the module is Microsoft.PowerShell.Core and not System.Management.Automation
if (parentModule != null && InitialSessionState.IsEngineModule(parentModule.Name))
{
iss.ImportCmdletsFromAssembly(assembly, parentModule);
}
else
{
iss.ImportCmdletsFromAssembly(assembly, null);
}
}
else
{
string binaryPath = fileName;
modulePath = fileName;
if (binaryPath == null)
{
binaryPath = System.IO.Path.Combine(moduleBase, moduleName);
}
BinaryAnalysisResult analysisResult = GetCmdletsFromBinaryModuleImplementation(binaryPath, manifestProcessingFlags, out assemblyVersion);
detectedCmdlets = analysisResult.DetectedCmdlets;
detectedAliases = analysisResult.DetectedAliases;
}
}
BinaryAnalysisResult analysisResult = GetCmdletsFromBinaryModuleImplementation(binaryPath, manifestProcessingFlags, out assemblyVersion);
detectedCmdlets = analysisResult.DetectedCmdlets;
detectedAliases = analysisResult.DetectedAliases;
}
found = true;
src/System.Management.Automation/engine/parser/Parser.cs
+5
View File
@@ -142,6 +142,11 @@ namespace System.Management.Automation.Language
/// <returns>The <see cref="ScriptBlockAst"/> that represents the input script file.</returns>
public static ScriptBlockAst ParseInput(string input, string fileName, out Token[] tokens, out ParseError[] errors)
{
if (input is null)
{
throw new ArgumentNullException(nameof(input));
}
Parser parser = new Parser();
List<Token> tokenList = new List<Token>();
ScriptBlockAst result;