Skip to content

Optimize Get-ChildItem -Recurse -Name #12834

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
iSazonov wants to merge 15 commits into from
Closed

Optimize Get-ChildItem -Recurse -Name #12834

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c544db4
Introduce new file enumerator for Get-ChildItem -Recorse -Name
iSazonov Jan 17, 2020
10e4c32
Process errors while enumerating
iSazonov Feb 14, 2020
0f03d7d
Add more tests
iSazonov Feb 14, 2020
f5515f4
Fix MacOS tests
iSazonov Jun 1, 2020
7d4724a
Test 1
iSazonov Jun 2, 2020
003f101
Test 2
iSazonov Oct 20, 2020
aaf5581
Revert depth to old code path
iSazonov Dec 16, 2020
61e9eca
Fix compile
iSazonov Dec 16, 2020
595a8d9
Fix compile 2
iSazonov Dec 16, 2020
0de6cd7
Fix style issues
iSazonov Dec 16, 2020
e76af74
Fix style issues 2
iSazonov Dec 16, 2020
2d6c4dd
Fix style issues 3
iSazonov Dec 16, 2020
c655a63
Fix style issues 4
iSazonov Dec 17, 2020
bb83259
Add depth support
iSazonov Dec 28, 2020
14a71e9
Fix style issues 5
iSazonov Dec 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 64 additions & 20 deletions src/System.Management.Automation/engine/SessionStateContainer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2380,16 +2380,38 @@ internal void GetChildNames(
// Since the path contained glob characters or we are recursing and the
// path is a container, do the name enumeration manually

DoGetChildNamesManually(
providerInstance,
providerPath,
string.Empty,
returnContainers,
includeMatcher,
excludeMatcher,
context,
recurse,
depth);
if (providerInstance is Microsoft.PowerShell.Commands.FileSystemProvider fileSystemProvider)
{
string newProviderPath =
MakePath(
providerInstance,
providerPath,
string.Empty,
context);

fileSystemProvider.DoGetChildNamesFast(
providerInstance,
newProviderPath,
returnContainers,
includeMatcher,
excludeMatcher,
context,
recurse,
depth);
}
else
{
DoGetChildNamesManually(
providerInstance,
providerPath,
string.Empty,
returnContainers,
includeMatcher,
excludeMatcher,
context,
recurse,
depth);
}
}
else
{
Expand Down Expand Up @@ -2466,16 +2488,38 @@ internal void GetChildNames(
// The path did not contain glob characters but recurse was specified
// so do the enumeration manually

DoGetChildNamesManually(
providerInstance,
providerPath,
string.Empty,
returnContainers,
includeMatcher,
excludeMatcher,
context,
recurse,
depth);
if (providerInstance is Microsoft.PowerShell.Commands.FileSystemProvider fileSystemProvider)
{
string newProviderPath =
MakePath(
providerInstance,
providerPath,
string.Empty,
context);

fileSystemProvider.DoGetChildNamesFast(
providerInstance,
newProviderPath,
returnContainers,
includeMatcher,
excludeMatcher,
context,
recurse,
depth);
}
else
{
DoGetChildNamesManually(
providerInstance,
providerPath,
string.Empty,
returnContainers,
includeMatcher,
excludeMatcher,
context,
recurse,
depth);
}
}
else
{
Expand Down
107 changes: 107 additions & 0 deletions src/System.Management.Automation/namespaces/FileSystemProviderEnumerable.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

#nullable enable

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.IO.Enumeration;
using System.Threading;

namespace Microsoft.PowerShell.Commands
{
/// <summary>
/// Enumerable that allows utilizing custom filter predicates and tranform delegates.
/// </summary>
/// <typeparam name="TResult">The type of a result.</typeparam>
internal class FileSystemProviderEnumerable<TResult> : IEnumerable<TResult>
{
private readonly FindTransform _transform;
private readonly EnumerationOptions _options;
private readonly string _directory;
private DelegateEnumerator? _enumerator;

/// <summary>
/// Initializes a new instance of the <see cref="FileSystemProviderEnumerable{TResult}"/> class.
/// The class allows utilizing custom filter predicates and tranform delegates.
/// </summary>
/// <param name="directory">The path of the starting directory.</param>
/// <param name="transform">The delegate to transform internal data to a result.</param>
/// <param name="options">The enumeration options.</param>
internal FileSystemProviderEnumerable(string directory, FindTransform transform, EnumerationOptions? options = null)
{
_directory = directory ?? throw new ArgumentNullException(nameof(directory));
_transform = transform ?? throw new ArgumentNullException(nameof(transform));
_options = options ?? new EnumerationOptions();

// We need to create the enumerator up front to ensure that we throw I/O exceptions for
// the root directory on creation of the enumerable.
_enumerator = new DelegateEnumerator(this);
}

internal FindPredicate? ShouldIncludePredicate { get; set; }

internal FindPredicate? ShouldRecursePredicate { get; set; }

internal ContinueOnErrorPredicate? ShouldContinueOnErrorPredicate { get; set; }

public IEnumerator<TResult> GetEnumerator()
{
return Interlocked.Exchange(ref _enumerator, null) ?? new DelegateEnumerator(this);
}

IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();

/// <summary>
/// Delegate for filtering out find results.
/// </summary>
/// <param name="entry">A lower level view of System.IO.FileSystemInfo for fitering.</param>
/// <returns>If true include the entry to result.</returns>
internal delegate bool FindPredicate(ref FileSystemEntry entry);

/// <summary>
/// Delegate for calling whenever the end of a directory is reached.
/// </summary>
/// <param name="directory">The path of the directory that finished.</param>
internal delegate void OnDirectoryFinishedDelegate(ReadOnlySpan<char> directory);

/// <summary>
/// Delegate for calling whenever on I/O error.
/// </summary>
/// <param name="error">I/O error code.</param>
/// <returns>If true continue the enumeration. If false throw.</returns>
internal delegate bool ContinueOnErrorPredicate(int error);

/// <summary>
/// Delegate for transforming raw find data into a result.
/// </summary>
/// <param name="entry">A lower level view of System.IO.FileSystemInfo for transforming to TResult.</param>
/// <returns>Result of the transformation of TResult type.</returns>
internal delegate TResult FindTransform(ref FileSystemEntry entry);

private sealed class DelegateEnumerator : FileSystemEnumerator<TResult>
{
private readonly FileSystemProviderEnumerable<TResult> _enumerable;

internal DelegateEnumerator(FileSystemProviderEnumerable<TResult> enumerable)
: base(enumerable._directory, enumerable._options)
{
_enumerable = enumerable;
}

protected override TResult TransformEntry(ref FileSystemEntry entry) => _enumerable._transform(ref entry);

protected override bool ShouldRecurseIntoEntry(ref FileSystemEntry entry)
=> _enumerable.ShouldRecursePredicate?.Invoke(ref entry) ?? true;

protected override bool ShouldIncludeEntry(ref FileSystemEntry entry)
=> _enumerable.ShouldIncludePredicate?.Invoke(ref entry) ?? true;

protected override bool ContinueOnError(int error)
//// Here _enumerable can be still null because base constructor can throw 'access denied' before we assign _enumerable.
=> _enumerable?.ShouldContinueOnErrorPredicate?.Invoke(error) ?? false;
}
}
}
Loading