139f186e57
This replaces the use of channels in the parallel directory traversal with a simple stack. The primary motivation for this change is to reduce peak memory usage. In particular, when using a channel (which is a queue), we wind up visiting files in a breadth first fashion. Using a stack switches us to a depth first traversal. While there are no real intrinsic differences, depth first traversal generally tends to use less memory because directory trees are more commonly wide than they are deep. In particular, the queue/stack size itself is not the only concern. In one recent case documented in #1550, a user wanted to search all Rust crates. The directory structure was shallow but extremely wide, with a single directory containing all crates. This in turn results is in descending into each of those directories and building a gitignore matcher for each (since most crates have `.gitignore` files) before ever searching a single file. This means that ripgrep has all such matchers in memory simultaneously, which winds up using quite a bit of memory. In a depth first traversal, peak memory usage is much lower because gitignore matches are built and discarded more quickly. In the case of searching all crates, the peak memory usage decrease is dramatic. On my system, it shrinks by an order magnitude, from almost 1GB to 50MB. The decline in peak memory usage is consistent across other use cases as well, but is typically more modest. For example, searching the Linux repo has a 50% decrease in peak memory usage and searching the Chromium repo has a 25% decrease in peak memory usage. Search times generally remain unchanged, although some ad hoc benchmarks that I typically run have gotten a bit slower. As far as I can tell, this appears to be result of scheduling changes. Namely, the depth first traversal seems to result in searching some very large files towards the end of the search, which reduces the effectiveness of parallelism and makes the overall search take longer. This seems to suggest that a stack isn't optimal. It would instead perhaps be better to prioritize searching larger files first, but it's not quite clear how to do this without introducing more overhead (getting the file size for each file requires a stat call). Fixes #1550
2178 lines
71 KiB
Rust
2178 lines
71 KiB
Rust
use std::cmp;
|
|
use std::ffi::OsStr;
|
|
use std::fmt;
|
|
use std::fs::{self, FileType, Metadata};
|
|
use std::io;
|
|
use std::path::{Path, PathBuf};
|
|
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
|
|
use std::sync::{Arc, Mutex};
|
|
use std::thread;
|
|
use std::time::Duration;
|
|
use std::vec;
|
|
|
|
use same_file::Handle;
|
|
use walkdir::{self, WalkDir};
|
|
|
|
use dir::{Ignore, IgnoreBuilder};
|
|
use gitignore::GitignoreBuilder;
|
|
use overrides::Override;
|
|
use types::Types;
|
|
use {Error, PartialErrorBuilder};
|
|
|
|
/// A directory entry with a possible error attached.
|
|
///
|
|
/// The error typically refers to a problem parsing ignore files in a
|
|
/// particular directory.
|
|
#[derive(Clone, Debug)]
|
|
pub struct DirEntry {
|
|
dent: DirEntryInner,
|
|
err: Option<Error>,
|
|
}
|
|
|
|
impl DirEntry {
|
|
/// The full path that this entry represents.
|
|
pub fn path(&self) -> &Path {
|
|
self.dent.path()
|
|
}
|
|
|
|
/// The full path that this entry represents.
|
|
/// Analogous to [`path`], but moves ownership of the path.
|
|
///
|
|
/// [`path`]: struct.DirEntry.html#method.path
|
|
pub fn into_path(self) -> PathBuf {
|
|
self.dent.into_path()
|
|
}
|
|
|
|
/// Whether this entry corresponds to a symbolic link or not.
|
|
pub fn path_is_symlink(&self) -> bool {
|
|
self.dent.path_is_symlink()
|
|
}
|
|
|
|
/// Returns true if and only if this entry corresponds to stdin.
|
|
///
|
|
/// i.e., The entry has depth 0 and its file name is `-`.
|
|
pub fn is_stdin(&self) -> bool {
|
|
self.dent.is_stdin()
|
|
}
|
|
|
|
/// Return the metadata for the file that this entry points to.
|
|
pub fn metadata(&self) -> Result<Metadata, Error> {
|
|
self.dent.metadata()
|
|
}
|
|
|
|
/// Return the file type for the file that this entry points to.
|
|
///
|
|
/// This entry doesn't have a file type if it corresponds to stdin.
|
|
pub fn file_type(&self) -> Option<FileType> {
|
|
self.dent.file_type()
|
|
}
|
|
|
|
/// Return the file name of this entry.
|
|
///
|
|
/// If this entry has no file name (e.g., `/`), then the full path is
|
|
/// returned.
|
|
pub fn file_name(&self) -> &OsStr {
|
|
self.dent.file_name()
|
|
}
|
|
|
|
/// Returns the depth at which this entry was created relative to the root.
|
|
pub fn depth(&self) -> usize {
|
|
self.dent.depth()
|
|
}
|
|
|
|
/// Returns the underlying inode number if one exists.
|
|
///
|
|
/// If this entry doesn't have an inode number, then `None` is returned.
|
|
#[cfg(unix)]
|
|
pub fn ino(&self) -> Option<u64> {
|
|
self.dent.ino()
|
|
}
|
|
|
|
/// Returns an error, if one exists, associated with processing this entry.
|
|
///
|
|
/// An example of an error is one that occurred while parsing an ignore
|
|
/// file. Errors related to traversing a directory tree itself are reported
|
|
/// as part of yielding the directory entry, and not with this method.
|
|
pub fn error(&self) -> Option<&Error> {
|
|
self.err.as_ref()
|
|
}
|
|
|
|
/// Returns true if and only if this entry points to a directory.
|
|
pub(crate) fn is_dir(&self) -> bool {
|
|
self.dent.is_dir()
|
|
}
|
|
|
|
fn new_stdin() -> DirEntry {
|
|
DirEntry { dent: DirEntryInner::Stdin, err: None }
|
|
}
|
|
|
|
fn new_walkdir(dent: walkdir::DirEntry, err: Option<Error>) -> DirEntry {
|
|
DirEntry { dent: DirEntryInner::Walkdir(dent), err: err }
|
|
}
|
|
|
|
fn new_raw(dent: DirEntryRaw, err: Option<Error>) -> DirEntry {
|
|
DirEntry { dent: DirEntryInner::Raw(dent), err: err }
|
|
}
|
|
}
|
|
|
|
/// DirEntryInner is the implementation of DirEntry.
|
|
///
|
|
/// It specifically represents three distinct sources of directory entries:
|
|
///
|
|
/// 1. From the walkdir crate.
|
|
/// 2. Special entries that represent things like stdin.
|
|
/// 3. From a path.
|
|
///
|
|
/// Specifically, (3) has to essentially re-create the DirEntry implementation
|
|
/// from WalkDir.
|
|
#[derive(Clone, Debug)]
|
|
enum DirEntryInner {
|
|
Stdin,
|
|
Walkdir(walkdir::DirEntry),
|
|
Raw(DirEntryRaw),
|
|
}
|
|
|
|
impl DirEntryInner {
|
|
fn path(&self) -> &Path {
|
|
use self::DirEntryInner::*;
|
|
match *self {
|
|
Stdin => Path::new("<stdin>"),
|
|
Walkdir(ref x) => x.path(),
|
|
Raw(ref x) => x.path(),
|
|
}
|
|
}
|
|
|
|
fn into_path(self) -> PathBuf {
|
|
use self::DirEntryInner::*;
|
|
match self {
|
|
Stdin => PathBuf::from("<stdin>"),
|
|
Walkdir(x) => x.into_path(),
|
|
Raw(x) => x.into_path(),
|
|
}
|
|
}
|
|
|
|
fn path_is_symlink(&self) -> bool {
|
|
use self::DirEntryInner::*;
|
|
match *self {
|
|
Stdin => false,
|
|
Walkdir(ref x) => x.path_is_symlink(),
|
|
Raw(ref x) => x.path_is_symlink(),
|
|
}
|
|
}
|
|
|
|
fn is_stdin(&self) -> bool {
|
|
match *self {
|
|
DirEntryInner::Stdin => true,
|
|
_ => false,
|
|
}
|
|
}
|
|
|
|
fn metadata(&self) -> Result<Metadata, Error> {
|
|
use self::DirEntryInner::*;
|
|
match *self {
|
|
Stdin => {
|
|
let err = Error::Io(io::Error::new(
|
|
io::ErrorKind::Other,
|
|
"<stdin> has no metadata",
|
|
));
|
|
Err(err.with_path("<stdin>"))
|
|
}
|
|
Walkdir(ref x) => x.metadata().map_err(|err| {
|
|
Error::Io(io::Error::from(err)).with_path(x.path())
|
|
}),
|
|
Raw(ref x) => x.metadata(),
|
|
}
|
|
}
|
|
|
|
fn file_type(&self) -> Option<FileType> {
|
|
use self::DirEntryInner::*;
|
|
match *self {
|
|
Stdin => None,
|
|
Walkdir(ref x) => Some(x.file_type()),
|
|
Raw(ref x) => Some(x.file_type()),
|
|
}
|
|
}
|
|
|
|
fn file_name(&self) -> &OsStr {
|
|
use self::DirEntryInner::*;
|
|
match *self {
|
|
Stdin => OsStr::new("<stdin>"),
|
|
Walkdir(ref x) => x.file_name(),
|
|
Raw(ref x) => x.file_name(),
|
|
}
|
|
}
|
|
|
|
fn depth(&self) -> usize {
|
|
use self::DirEntryInner::*;
|
|
match *self {
|
|
Stdin => 0,
|
|
Walkdir(ref x) => x.depth(),
|
|
Raw(ref x) => x.depth(),
|
|
}
|
|
}
|
|
|
|
#[cfg(unix)]
|
|
fn ino(&self) -> Option<u64> {
|
|
use self::DirEntryInner::*;
|
|
use walkdir::DirEntryExt;
|
|
match *self {
|
|
Stdin => None,
|
|
Walkdir(ref x) => Some(x.ino()),
|
|
Raw(ref x) => Some(x.ino()),
|
|
}
|
|
}
|
|
|
|
/// Returns true if and only if this entry points to a directory.
|
|
fn is_dir(&self) -> bool {
|
|
self.file_type().map(|ft| ft.is_dir()).unwrap_or(false)
|
|
}
|
|
}
|
|
|
|
/// DirEntryRaw is essentially copied from the walkdir crate so that we can
|
|
/// build `DirEntry`s from whole cloth in the parallel iterator.
|
|
#[derive(Clone)]
|
|
struct DirEntryRaw {
|
|
/// The path as reported by the `fs::ReadDir` iterator (even if it's a
|
|
/// symbolic link).
|
|
path: PathBuf,
|
|
/// The file type. Necessary for recursive iteration, so store it.
|
|
ty: FileType,
|
|
/// Is set when this entry was created from a symbolic link and the user
|
|
/// expects the iterator to follow symbolic links.
|
|
follow_link: bool,
|
|
/// The depth at which this entry was generated relative to the root.
|
|
depth: usize,
|
|
/// The underlying inode number (Unix only).
|
|
#[cfg(unix)]
|
|
ino: u64,
|
|
/// The underlying metadata (Windows only). We store this on Windows
|
|
/// because this comes for free while reading a directory.
|
|
#[cfg(windows)]
|
|
metadata: fs::Metadata,
|
|
}
|
|
|
|
impl fmt::Debug for DirEntryRaw {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
// Leaving out FileType because it doesn't have a debug impl
|
|
// in Rust 1.9. We could add it if we really wanted to by manually
|
|
// querying each possibly file type. Meh. ---AG
|
|
f.debug_struct("DirEntryRaw")
|
|
.field("path", &self.path)
|
|
.field("follow_link", &self.follow_link)
|
|
.field("depth", &self.depth)
|
|
.finish()
|
|
}
|
|
}
|
|
|
|
impl DirEntryRaw {
|
|
fn path(&self) -> &Path {
|
|
&self.path
|
|
}
|
|
|
|
fn into_path(self) -> PathBuf {
|
|
self.path
|
|
}
|
|
|
|
fn path_is_symlink(&self) -> bool {
|
|
self.ty.is_symlink() || self.follow_link
|
|
}
|
|
|
|
fn metadata(&self) -> Result<Metadata, Error> {
|
|
self.metadata_internal()
|
|
}
|
|
|
|
#[cfg(windows)]
|
|
fn metadata_internal(&self) -> Result<fs::Metadata, Error> {
|
|
if self.follow_link {
|
|
fs::metadata(&self.path)
|
|
} else {
|
|
Ok(self.metadata.clone())
|
|
}
|
|
.map_err(|err| Error::Io(io::Error::from(err)).with_path(&self.path))
|
|
}
|
|
|
|
#[cfg(not(windows))]
|
|
fn metadata_internal(&self) -> Result<fs::Metadata, Error> {
|
|
if self.follow_link {
|
|
fs::metadata(&self.path)
|
|
} else {
|
|
fs::symlink_metadata(&self.path)
|
|
}
|
|
.map_err(|err| Error::Io(io::Error::from(err)).with_path(&self.path))
|
|
}
|
|
|
|
fn file_type(&self) -> FileType {
|
|
self.ty
|
|
}
|
|
|
|
fn file_name(&self) -> &OsStr {
|
|
self.path.file_name().unwrap_or_else(|| self.path.as_os_str())
|
|
}
|
|
|
|
fn depth(&self) -> usize {
|
|
self.depth
|
|
}
|
|
|
|
#[cfg(unix)]
|
|
fn ino(&self) -> u64 {
|
|
self.ino
|
|
}
|
|
|
|
fn from_entry(
|
|
depth: usize,
|
|
ent: &fs::DirEntry,
|
|
) -> Result<DirEntryRaw, Error> {
|
|
let ty = ent.file_type().map_err(|err| {
|
|
let err = Error::Io(io::Error::from(err)).with_path(ent.path());
|
|
Error::WithDepth { depth: depth, err: Box::new(err) }
|
|
})?;
|
|
DirEntryRaw::from_entry_os(depth, ent, ty)
|
|
}
|
|
|
|
#[cfg(windows)]
|
|
fn from_entry_os(
|
|
depth: usize,
|
|
ent: &fs::DirEntry,
|
|
ty: fs::FileType,
|
|
) -> Result<DirEntryRaw, Error> {
|
|
let md = ent.metadata().map_err(|err| {
|
|
let err = Error::Io(io::Error::from(err)).with_path(ent.path());
|
|
Error::WithDepth { depth: depth, err: Box::new(err) }
|
|
})?;
|
|
Ok(DirEntryRaw {
|
|
path: ent.path(),
|
|
ty: ty,
|
|
follow_link: false,
|
|
depth: depth,
|
|
metadata: md,
|
|
})
|
|
}
|
|
|
|
#[cfg(unix)]
|
|
fn from_entry_os(
|
|
depth: usize,
|
|
ent: &fs::DirEntry,
|
|
ty: fs::FileType,
|
|
) -> Result<DirEntryRaw, Error> {
|
|
use std::os::unix::fs::DirEntryExt;
|
|
|
|
Ok(DirEntryRaw {
|
|
path: ent.path(),
|
|
ty: ty,
|
|
follow_link: false,
|
|
depth: depth,
|
|
ino: ent.ino(),
|
|
})
|
|
}
|
|
|
|
// Placeholder implementation to allow compiling on non-standard platforms
|
|
// (e.g. wasm32).
|
|
#[cfg(not(any(windows, unix)))]
|
|
fn from_entry_os(
|
|
depth: usize,
|
|
ent: &fs::DirEntry,
|
|
ty: fs::FileType,
|
|
) -> Result<DirEntryRaw, Error> {
|
|
Err(Error::Io(io::Error::new(
|
|
io::ErrorKind::Other,
|
|
"unsupported platform",
|
|
)))
|
|
}
|
|
|
|
#[cfg(windows)]
|
|
fn from_path(
|
|
depth: usize,
|
|
pb: PathBuf,
|
|
link: bool,
|
|
) -> Result<DirEntryRaw, Error> {
|
|
let md =
|
|
fs::metadata(&pb).map_err(|err| Error::Io(err).with_path(&pb))?;
|
|
Ok(DirEntryRaw {
|
|
path: pb,
|
|
ty: md.file_type(),
|
|
follow_link: link,
|
|
depth: depth,
|
|
metadata: md,
|
|
})
|
|
}
|
|
|
|
#[cfg(unix)]
|
|
fn from_path(
|
|
depth: usize,
|
|
pb: PathBuf,
|
|
link: bool,
|
|
) -> Result<DirEntryRaw, Error> {
|
|
use std::os::unix::fs::MetadataExt;
|
|
|
|
let md =
|
|
fs::metadata(&pb).map_err(|err| Error::Io(err).with_path(&pb))?;
|
|
Ok(DirEntryRaw {
|
|
path: pb,
|
|
ty: md.file_type(),
|
|
follow_link: link,
|
|
depth: depth,
|
|
ino: md.ino(),
|
|
})
|
|
}
|
|
|
|
// Placeholder implementation to allow compiling on non-standard platforms
|
|
// (e.g. wasm32).
|
|
#[cfg(not(any(windows, unix)))]
|
|
fn from_path(
|
|
depth: usize,
|
|
pb: PathBuf,
|
|
link: bool,
|
|
) -> Result<DirEntryRaw, Error> {
|
|
Err(Error::Io(io::Error::new(
|
|
io::ErrorKind::Other,
|
|
"unsupported platform",
|
|
)))
|
|
}
|
|
}
|
|
|
|
/// WalkBuilder builds a recursive directory iterator.
|
|
///
|
|
/// The builder supports a large number of configurable options. This includes
|
|
/// specific glob overrides, file type matching, toggling whether hidden
|
|
/// files are ignored or not, and of course, support for respecting gitignore
|
|
/// files.
|
|
///
|
|
/// By default, all ignore files found are respected. This includes `.ignore`,
|
|
/// `.gitignore`, `.git/info/exclude` and even your global gitignore
|
|
/// globs, usually found in `$XDG_CONFIG_HOME/git/ignore`.
|
|
///
|
|
/// Some standard recursive directory options are also supported, such as
|
|
/// limiting the recursive depth or whether to follow symbolic links (disabled
|
|
/// by default).
|
|
///
|
|
/// # Ignore rules
|
|
///
|
|
/// There are many rules that influence whether a particular file or directory
|
|
/// is skipped by this iterator. Those rules are documented here. Note that
|
|
/// the rules assume a default configuration.
|
|
///
|
|
/// * First, glob overrides are checked. If a path matches a glob override,
|
|
/// then matching stops. The path is then only skipped if the glob that matched
|
|
/// the path is an ignore glob. (An override glob is a whitelist glob unless it
|
|
/// starts with a `!`, in which case it is an ignore glob.)
|
|
/// * Second, ignore files are checked. Ignore files currently only come from
|
|
/// git ignore files (`.gitignore`, `.git/info/exclude` and the configured
|
|
/// global gitignore file), plain `.ignore` files, which have the same format
|
|
/// as gitignore files, or explicitly added ignore files. The precedence order
|
|
/// is: `.ignore`, `.gitignore`, `.git/info/exclude`, global gitignore and
|
|
/// finally explicitly added ignore files. Note that precedence between
|
|
/// different types of ignore files is not impacted by the directory hierarchy;
|
|
/// any `.ignore` file overrides all `.gitignore` files. Within each precedence
|
|
/// level, more nested ignore files have a higher precedence than less nested
|
|
/// ignore files.
|
|
/// * Third, if the previous step yields an ignore match, then all matching
|
|
/// is stopped and the path is skipped. If it yields a whitelist match, then
|
|
/// matching continues. A whitelist match can be overridden by a later matcher.
|
|
/// * Fourth, unless the path is a directory, the file type matcher is run on
|
|
/// the path. As above, if it yields an ignore match, then all matching is
|
|
/// stopped and the path is skipped. If it yields a whitelist match, then
|
|
/// matching continues.
|
|
/// * Fifth, if the path hasn't been whitelisted and it is hidden, then the
|
|
/// path is skipped.
|
|
/// * Sixth, unless the path is a directory, the size of the file is compared
|
|
/// against the max filesize limit. If it exceeds the limit, it is skipped.
|
|
/// * Seventh, if the path has made it this far then it is yielded in the
|
|
/// iterator.
|
|
#[derive(Clone)]
|
|
pub struct WalkBuilder {
|
|
paths: Vec<PathBuf>,
|
|
ig_builder: IgnoreBuilder,
|
|
max_depth: Option<usize>,
|
|
max_filesize: Option<u64>,
|
|
follow_links: bool,
|
|
same_file_system: bool,
|
|
sorter: Option<Sorter>,
|
|
threads: usize,
|
|
skip: Option<Arc<Handle>>,
|
|
}
|
|
|
|
#[derive(Clone)]
|
|
enum Sorter {
|
|
ByName(
|
|
Arc<dyn Fn(&OsStr, &OsStr) -> cmp::Ordering + Send + Sync + 'static>,
|
|
),
|
|
ByPath(Arc<dyn Fn(&Path, &Path) -> cmp::Ordering + Send + Sync + 'static>),
|
|
}
|
|
|
|
impl fmt::Debug for WalkBuilder {
|
|
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
|
|
f.debug_struct("WalkBuilder")
|
|
.field("paths", &self.paths)
|
|
.field("ig_builder", &self.ig_builder)
|
|
.field("max_depth", &self.max_depth)
|
|
.field("max_filesize", &self.max_filesize)
|
|
.field("follow_links", &self.follow_links)
|
|
.field("threads", &self.threads)
|
|
.field("skip", &self.skip)
|
|
.finish()
|
|
}
|
|
}
|
|
|
|
impl WalkBuilder {
|
|
/// Create a new builder for a recursive directory iterator for the
|
|
/// directory given.
|
|
///
|
|
/// Note that if you want to traverse multiple different directories, it
|
|
/// is better to call `add` on this builder than to create multiple
|
|
/// `Walk` values.
|
|
pub fn new<P: AsRef<Path>>(path: P) -> WalkBuilder {
|
|
WalkBuilder {
|
|
paths: vec![path.as_ref().to_path_buf()],
|
|
ig_builder: IgnoreBuilder::new(),
|
|
max_depth: None,
|
|
max_filesize: None,
|
|
follow_links: false,
|
|
same_file_system: false,
|
|
sorter: None,
|
|
threads: 0,
|
|
skip: None,
|
|
}
|
|
}
|
|
|
|
/// Build a new `Walk` iterator.
|
|
pub fn build(&self) -> Walk {
|
|
let follow_links = self.follow_links;
|
|
let max_depth = self.max_depth;
|
|
let sorter = self.sorter.clone();
|
|
let its = self
|
|
.paths
|
|
.iter()
|
|
.map(move |p| {
|
|
if p == Path::new("-") {
|
|
(p.to_path_buf(), None)
|
|
} else {
|
|
let mut wd = WalkDir::new(p);
|
|
wd = wd.follow_links(follow_links || p.is_file());
|
|
wd = wd.same_file_system(self.same_file_system);
|
|
if let Some(max_depth) = max_depth {
|
|
wd = wd.max_depth(max_depth);
|
|
}
|
|
if let Some(ref sorter) = sorter {
|
|
match sorter.clone() {
|
|
Sorter::ByName(cmp) => {
|
|
wd = wd.sort_by(move |a, b| {
|
|
cmp(a.file_name(), b.file_name())
|
|
});
|
|
}
|
|
Sorter::ByPath(cmp) => {
|
|
wd = wd.sort_by(move |a, b| {
|
|
cmp(a.path(), b.path())
|
|
});
|
|
}
|
|
}
|
|
}
|
|
(p.to_path_buf(), Some(WalkEventIter::from(wd)))
|
|
}
|
|
})
|
|
.collect::<Vec<_>>()
|
|
.into_iter();
|
|
let ig_root = self.ig_builder.build();
|
|
Walk {
|
|
its: its,
|
|
it: None,
|
|
ig_root: ig_root.clone(),
|
|
ig: ig_root.clone(),
|
|
max_filesize: self.max_filesize,
|
|
skip: self.skip.clone(),
|
|
}
|
|
}
|
|
|
|
/// Build a new `WalkParallel` iterator.
|
|
///
|
|
/// Note that this *doesn't* return something that implements `Iterator`.
|
|
/// Instead, the returned value must be run with a closure. e.g.,
|
|
/// `builder.build_parallel().run(|| |path| println!("{:?}", path))`.
|
|
pub fn build_parallel(&self) -> WalkParallel {
|
|
WalkParallel {
|
|
paths: self.paths.clone().into_iter(),
|
|
ig_root: self.ig_builder.build(),
|
|
max_depth: self.max_depth,
|
|
max_filesize: self.max_filesize,
|
|
follow_links: self.follow_links,
|
|
same_file_system: self.same_file_system,
|
|
threads: self.threads,
|
|
skip: self.skip.clone(),
|
|
}
|
|
}
|
|
|
|
/// Add a file path to the iterator.
|
|
///
|
|
/// Each additional file path added is traversed recursively. This should
|
|
/// be preferred over building multiple `Walk` iterators since this
|
|
/// enables reusing resources across iteration.
|
|
pub fn add<P: AsRef<Path>>(&mut self, path: P) -> &mut WalkBuilder {
|
|
self.paths.push(path.as_ref().to_path_buf());
|
|
self
|
|
}
|
|
|
|
/// The maximum depth to recurse.
|
|
///
|
|
/// The default, `None`, imposes no depth restriction.
|
|
pub fn max_depth(&mut self, depth: Option<usize>) -> &mut WalkBuilder {
|
|
self.max_depth = depth;
|
|
self
|
|
}
|
|
|
|
/// Whether to follow symbolic links or not.
|
|
pub fn follow_links(&mut self, yes: bool) -> &mut WalkBuilder {
|
|
self.follow_links = yes;
|
|
self
|
|
}
|
|
|
|
/// Whether to ignore files above the specified limit.
|
|
pub fn max_filesize(&mut self, filesize: Option<u64>) -> &mut WalkBuilder {
|
|
self.max_filesize = filesize;
|
|
self
|
|
}
|
|
|
|
/// The number of threads to use for traversal.
|
|
///
|
|
/// Note that this only has an effect when using `build_parallel`.
|
|
///
|
|
/// The default setting is `0`, which chooses the number of threads
|
|
/// automatically using heuristics.
|
|
pub fn threads(&mut self, n: usize) -> &mut WalkBuilder {
|
|
self.threads = n;
|
|
self
|
|
}
|
|
|
|
/// Add a global ignore file to the matcher.
|
|
///
|
|
/// This has lower precedence than all other sources of ignore rules.
|
|
///
|
|
/// If there was a problem adding the ignore file, then an error is
|
|
/// returned. Note that the error may indicate *partial* failure. For
|
|
/// example, if an ignore file contains an invalid glob, all other globs
|
|
/// are still applied.
|
|
pub fn add_ignore<P: AsRef<Path>>(&mut self, path: P) -> Option<Error> {
|
|
let mut builder = GitignoreBuilder::new("");
|
|
let mut errs = PartialErrorBuilder::default();
|
|
errs.maybe_push(builder.add(path));
|
|
match builder.build() {
|
|
Ok(gi) => {
|
|
self.ig_builder.add_ignore(gi);
|
|
}
|
|
Err(err) => {
|
|
errs.push(err);
|
|
}
|
|
}
|
|
errs.into_error_option()
|
|
}
|
|
|
|
/// Add a custom ignore file name
|
|
///
|
|
/// These ignore files have higher precedence than all other ignore files.
|
|
///
|
|
/// When specifying multiple names, earlier names have lower precedence than
|
|
/// later names.
|
|
pub fn add_custom_ignore_filename<S: AsRef<OsStr>>(
|
|
&mut self,
|
|
file_name: S,
|
|
) -> &mut WalkBuilder {
|
|
self.ig_builder.add_custom_ignore_filename(file_name);
|
|
self
|
|
}
|
|
|
|
/// Add an override matcher.
|
|
///
|
|
/// By default, no override matcher is used.
|
|
///
|
|
/// This overrides any previous setting.
|
|
pub fn overrides(&mut self, overrides: Override) -> &mut WalkBuilder {
|
|
self.ig_builder.overrides(overrides);
|
|
self
|
|
}
|
|
|
|
/// Add a file type matcher.
|
|
///
|
|
/// By default, no file type matcher is used.
|
|
///
|
|
/// This overrides any previous setting.
|
|
pub fn types(&mut self, types: Types) -> &mut WalkBuilder {
|
|
self.ig_builder.types(types);
|
|
self
|
|
}
|
|
|
|
/// Enables all the standard ignore filters.
|
|
///
|
|
/// This toggles, as a group, all the filters that are enabled by default:
|
|
///
|
|
/// - [hidden()](#method.hidden)
|
|
/// - [parents()](#method.parents)
|
|
/// - [ignore()](#method.ignore)
|
|
/// - [git_ignore()](#method.git_ignore)
|
|
/// - [git_global()](#method.git_global)
|
|
/// - [git_exclude()](#method.git_exclude)
|
|
///
|
|
/// They may still be toggled individually after calling this function.
|
|
///
|
|
/// This is (by definition) enabled by default.
|
|
pub fn standard_filters(&mut self, yes: bool) -> &mut WalkBuilder {
|
|
self.hidden(yes)
|
|
.parents(yes)
|
|
.ignore(yes)
|
|
.git_ignore(yes)
|
|
.git_global(yes)
|
|
.git_exclude(yes)
|
|
}
|
|
|
|
/// Enables ignoring hidden files.
|
|
///
|
|
/// This is enabled by default.
|
|
pub fn hidden(&mut self, yes: bool) -> &mut WalkBuilder {
|
|
self.ig_builder.hidden(yes);
|
|
self
|
|
}
|
|
|
|
/// Enables reading ignore files from parent directories.
|
|
///
|
|
/// If this is enabled, then .gitignore files in parent directories of each
|
|
/// file path given are respected. Otherwise, they are ignored.
|
|
///
|
|
/// This is enabled by default.
|
|
pub fn parents(&mut self, yes: bool) -> &mut WalkBuilder {
|
|
self.ig_builder.parents(yes);
|
|
self
|
|
}
|
|
|
|
/// Enables reading `.ignore` files.
|
|
///
|
|
/// `.ignore` files have the same semantics as `gitignore` files and are
|
|
/// supported by search tools such as ripgrep and The Silver Searcher.
|
|
///
|
|
/// This is enabled by default.
|
|
pub fn ignore(&mut self, yes: bool) -> &mut WalkBuilder {
|
|
self.ig_builder.ignore(yes);
|
|
self
|
|
}
|
|
|
|
/// Enables reading a global gitignore file, whose path is specified in
|
|
/// git's `core.excludesFile` config option.
|
|
///
|
|
/// Git's config file location is `$HOME/.gitconfig`. If `$HOME/.gitconfig`
|
|
/// does not exist or does not specify `core.excludesFile`, then
|
|
/// `$XDG_CONFIG_HOME/git/ignore` is read. If `$XDG_CONFIG_HOME` is not
|
|
/// set or is empty, then `$HOME/.config/git/ignore` is used instead.
|
|
///
|
|
/// This is enabled by default.
|
|
pub fn git_global(&mut self, yes: bool) -> &mut WalkBuilder {
|
|
self.ig_builder.git_global(yes);
|
|
self
|
|
}
|
|
|
|
/// Enables reading `.gitignore` files.
|
|
///
|
|
/// `.gitignore` files have match semantics as described in the `gitignore`
|
|
/// man page.
|
|
///
|
|
/// This is enabled by default.
|
|
pub fn git_ignore(&mut self, yes: bool) -> &mut WalkBuilder {
|
|
self.ig_builder.git_ignore(yes);
|
|
self
|
|
}
|
|
|
|
/// Enables reading `.git/info/exclude` files.
|
|
///
|
|
/// `.git/info/exclude` files have match semantics as described in the
|
|
/// `gitignore` man page.
|
|
///
|
|
/// This is enabled by default.
|
|
pub fn git_exclude(&mut self, yes: bool) -> &mut WalkBuilder {
|
|
self.ig_builder.git_exclude(yes);
|
|
self
|
|
}
|
|
|
|
/// Whether a git repository is required to apply git-related ignore
|
|
/// rules (global rules, .gitignore and local exclude rules).
|
|
///
|
|
/// When disabled, git-related ignore rules are applied even when searching
|
|
/// outside a git repository.
|
|
pub fn require_git(&mut self, yes: bool) -> &mut WalkBuilder {
|
|
self.ig_builder.require_git(yes);
|
|
self
|
|
}
|
|
|
|
/// Process ignore files case insensitively
|
|
///
|
|
/// This is disabled by default.
|
|
pub fn ignore_case_insensitive(&mut self, yes: bool) -> &mut WalkBuilder {
|
|
self.ig_builder.ignore_case_insensitive(yes);
|
|
self
|
|
}
|
|
|
|
/// Set a function for sorting directory entries by their path.
|
|
///
|
|
/// If a compare function is set, the resulting iterator will return all
|
|
/// paths in sorted order. The compare function will be called to compare
|
|
/// entries from the same directory.
|
|
///
|
|
/// This is like `sort_by_file_name`, except the comparator accepts
|
|
/// a `&Path` instead of the base file name, which permits it to sort by
|
|
/// more criteria.
|
|
///
|
|
/// This method will override any previous sorter set by this method or
|
|
/// by `sort_by_file_name`.
|
|
///
|
|
/// Note that this is not used in the parallel iterator.
|
|
pub fn sort_by_file_path<F>(&mut self, cmp: F) -> &mut WalkBuilder
|
|
where
|
|
F: Fn(&Path, &Path) -> cmp::Ordering + Send + Sync + 'static,
|
|
{
|
|
self.sorter = Some(Sorter::ByPath(Arc::new(cmp)));
|
|
self
|
|
}
|
|
|
|
/// Set a function for sorting directory entries by file name.
|
|
///
|
|
/// If a compare function is set, the resulting iterator will return all
|
|
/// paths in sorted order. The compare function will be called to compare
|
|
/// names from entries from the same directory using only the name of the
|
|
/// entry.
|
|
///
|
|
/// This method will override any previous sorter set by this method or
|
|
/// by `sort_by_file_path`.
|
|
///
|
|
/// Note that this is not used in the parallel iterator.
|
|
pub fn sort_by_file_name<F>(&mut self, cmp: F) -> &mut WalkBuilder
|
|
where
|
|
F: Fn(&OsStr, &OsStr) -> cmp::Ordering + Send + Sync + 'static,
|
|
{
|
|
self.sorter = Some(Sorter::ByName(Arc::new(cmp)));
|
|
self
|
|
}
|
|
|
|
/// Do not cross file system boundaries.
|
|
///
|
|
/// When this option is enabled, directory traversal will not descend into
|
|
/// directories that are on a different file system from the root path.
|
|
///
|
|
/// Currently, this option is only supported on Unix and Windows. If this
|
|
/// option is used on an unsupported platform, then directory traversal
|
|
/// will immediately return an error and will not yield any entries.
|
|
pub fn same_file_system(&mut self, yes: bool) -> &mut WalkBuilder {
|
|
self.same_file_system = yes;
|
|
self
|
|
}
|
|
|
|
/// Do not yield directory entries that are believed to correspond to
|
|
/// stdout.
|
|
///
|
|
/// This is useful when a command is invoked via shell redirection to a
|
|
/// file that is also being read. For example, `grep -r foo ./ > results`
|
|
/// might end up trying to search `results` even though it is also writing
|
|
/// to it, which could cause an unbounded feedback loop. Setting this
|
|
/// option prevents this from happening by skipping over the `results`
|
|
/// file.
|
|
///
|
|
/// This is disabled by default.
|
|
pub fn skip_stdout(&mut self, yes: bool) -> &mut WalkBuilder {
|
|
if yes {
|
|
self.skip = stdout_handle().map(Arc::new);
|
|
} else {
|
|
self.skip = None;
|
|
}
|
|
self
|
|
}
|
|
}
|
|
|
|
/// Walk is a recursive directory iterator over file paths in one or more
|
|
/// directories.
|
|
///
|
|
/// Only file and directory paths matching the rules are returned. By default,
|
|
/// ignore files like `.gitignore` are respected. The precise matching rules
|
|
/// and precedence is explained in the documentation for `WalkBuilder`.
|
|
pub struct Walk {
|
|
its: vec::IntoIter<(PathBuf, Option<WalkEventIter>)>,
|
|
it: Option<WalkEventIter>,
|
|
ig_root: Ignore,
|
|
ig: Ignore,
|
|
max_filesize: Option<u64>,
|
|
skip: Option<Arc<Handle>>,
|
|
}
|
|
|
|
impl Walk {
|
|
/// Creates a new recursive directory iterator for the file path given.
|
|
///
|
|
/// Note that this uses default settings, which include respecting
|
|
/// `.gitignore` files. To configure the iterator, use `WalkBuilder`
|
|
/// instead.
|
|
pub fn new<P: AsRef<Path>>(path: P) -> Walk {
|
|
WalkBuilder::new(path).build()
|
|
}
|
|
|
|
fn skip_entry(&self, ent: &DirEntry) -> Result<bool, Error> {
|
|
if ent.depth() == 0 {
|
|
return Ok(false);
|
|
}
|
|
|
|
if let Some(ref stdout) = self.skip {
|
|
if path_equals(ent, stdout)? {
|
|
return Ok(true);
|
|
}
|
|
}
|
|
if should_skip_entry(&self.ig, ent) {
|
|
return Ok(true);
|
|
}
|
|
if self.max_filesize.is_some() && !ent.is_dir() {
|
|
return Ok(skip_filesize(
|
|
self.max_filesize.unwrap(),
|
|
ent.path(),
|
|
&ent.metadata().ok(),
|
|
));
|
|
}
|
|
Ok(false)
|
|
}
|
|
}
|
|
|
|
impl Iterator for Walk {
|
|
type Item = Result<DirEntry, Error>;
|
|
|
|
#[inline(always)]
|
|
fn next(&mut self) -> Option<Result<DirEntry, Error>> {
|
|
loop {
|
|
let ev = match self.it.as_mut().and_then(|it| it.next()) {
|
|
Some(ev) => ev,
|
|
None => {
|
|
match self.its.next() {
|
|
None => return None,
|
|
Some((_, None)) => {
|
|
return Some(Ok(DirEntry::new_stdin()));
|
|
}
|
|
Some((path, Some(it))) => {
|
|
self.it = Some(it);
|
|
if path.is_dir() {
|
|
let (ig, err) = self.ig_root.add_parents(path);
|
|
self.ig = ig;
|
|
if let Some(err) = err {
|
|
return Some(Err(err));
|
|
}
|
|
} else {
|
|
self.ig = self.ig_root.clone();
|
|
}
|
|
}
|
|
}
|
|
continue;
|
|
}
|
|
};
|
|
match ev {
|
|
Err(err) => {
|
|
return Some(Err(Error::from_walkdir(err)));
|
|
}
|
|
Ok(WalkEvent::Exit) => {
|
|
self.ig = self.ig.parent().unwrap();
|
|
}
|
|
Ok(WalkEvent::Dir(ent)) => {
|
|
let mut ent = DirEntry::new_walkdir(ent, None);
|
|
let should_skip = match self.skip_entry(&ent) {
|
|
Err(err) => return Some(Err(err)),
|
|
Ok(should_skip) => should_skip,
|
|
};
|
|
if should_skip {
|
|
self.it.as_mut().unwrap().it.skip_current_dir();
|
|
// Still need to push this on the stack because
|
|
// we'll get a WalkEvent::Exit event for this dir.
|
|
// We don't care if it errors though.
|
|
let (igtmp, _) = self.ig.add_child(ent.path());
|
|
self.ig = igtmp;
|
|
continue;
|
|
}
|
|
let (igtmp, err) = self.ig.add_child(ent.path());
|
|
self.ig = igtmp;
|
|
ent.err = err;
|
|
return Some(Ok(ent));
|
|
}
|
|
Ok(WalkEvent::File(ent)) => {
|
|
let ent = DirEntry::new_walkdir(ent, None);
|
|
let should_skip = match self.skip_entry(&ent) {
|
|
Err(err) => return Some(Err(err)),
|
|
Ok(should_skip) => should_skip,
|
|
};
|
|
if should_skip {
|
|
continue;
|
|
}
|
|
return Some(Ok(ent));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// WalkEventIter transforms a WalkDir iterator into an iterator that more
|
|
/// accurately describes the directory tree. Namely, it emits events that are
|
|
/// one of three types: directory, file or "exit." An "exit" event means that
|
|
/// the entire contents of a directory have been enumerated.
|
|
struct WalkEventIter {
|
|
depth: usize,
|
|
it: walkdir::IntoIter,
|
|
next: Option<Result<walkdir::DirEntry, walkdir::Error>>,
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
enum WalkEvent {
|
|
Dir(walkdir::DirEntry),
|
|
File(walkdir::DirEntry),
|
|
Exit,
|
|
}
|
|
|
|
impl From<WalkDir> for WalkEventIter {
|
|
fn from(it: WalkDir) -> WalkEventIter {
|
|
WalkEventIter { depth: 0, it: it.into_iter(), next: None }
|
|
}
|
|
}
|
|
|
|
impl Iterator for WalkEventIter {
|
|
type Item = walkdir::Result<WalkEvent>;
|
|
|
|
#[inline(always)]
|
|
fn next(&mut self) -> Option<walkdir::Result<WalkEvent>> {
|
|
let dent = self.next.take().or_else(|| self.it.next());
|
|
let depth = match dent {
|
|
None => 0,
|
|
Some(Ok(ref dent)) => dent.depth(),
|
|
Some(Err(ref err)) => err.depth(),
|
|
};
|
|
if depth < self.depth {
|
|
self.depth -= 1;
|
|
self.next = dent;
|
|
return Some(Ok(WalkEvent::Exit));
|
|
}
|
|
self.depth = depth;
|
|
match dent {
|
|
None => None,
|
|
Some(Err(err)) => Some(Err(err)),
|
|
Some(Ok(dent)) => {
|
|
if walkdir_is_dir(&dent) {
|
|
self.depth += 1;
|
|
Some(Ok(WalkEvent::Dir(dent)))
|
|
} else {
|
|
Some(Ok(WalkEvent::File(dent)))
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// WalkState is used in the parallel recursive directory iterator to indicate
|
|
/// whether walking should continue as normal, skip descending into a
|
|
/// particular directory or quit the walk entirely.
|
|
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
|
|
pub enum WalkState {
|
|
/// Continue walking as normal.
|
|
Continue,
|
|
/// If the directory entry given is a directory, don't descend into it.
|
|
/// In all other cases, this has no effect.
|
|
Skip,
|
|
/// Quit the entire iterator as soon as possible.
|
|
///
|
|
/// Note that this is an inherently asynchronous action. It is possible
|
|
/// for more entries to be yielded even after instructing the iterator
|
|
/// to quit.
|
|
Quit,
|
|
}
|
|
|
|
impl WalkState {
|
|
fn is_continue(&self) -> bool {
|
|
*self == WalkState::Continue
|
|
}
|
|
|
|
fn is_quit(&self) -> bool {
|
|
*self == WalkState::Quit
|
|
}
|
|
}
|
|
|
|
/// A builder for constructing a visitor when using
|
|
/// [`WalkParallel::visit`](struct.WalkParallel.html#method.visit). The builder
|
|
/// will be called for each thread started by `WalkParallel`. The visitor
|
|
/// returned from each builder is then called for every directory entry.
|
|
pub trait ParallelVisitorBuilder<'s> {
|
|
/// Create per-thread `ParallelVisitor`s for `WalkParallel`.
|
|
fn build(&mut self) -> Box<dyn ParallelVisitor + 's>;
|
|
}
|
|
|
|
impl<'a, 's, P: ParallelVisitorBuilder<'s>> ParallelVisitorBuilder<'s>
|
|
for &'a mut P
|
|
{
|
|
fn build(&mut self) -> Box<dyn ParallelVisitor + 's> {
|
|
(**self).build()
|
|
}
|
|
}
|
|
|
|
/// Receives files and directories for the current thread.
|
|
///
|
|
/// Setup for the traversal can be implemented as part of
|
|
/// [`ParallelVisitorBuilder::build`](trait.ParallelVisitorBuilder.html#tymethod.build).
|
|
/// Teardown when traversal finishes can be implemented by implementing the
|
|
/// `Drop` trait on your traversal type.
|
|
pub trait ParallelVisitor: Send {
|
|
/// Receives files and directories for the current thread. This is called
|
|
/// once for every directory entry visited by traversal.
|
|
fn visit(&mut self, entry: Result<DirEntry, Error>) -> WalkState;
|
|
}
|
|
|
|
struct FnBuilder<F> {
|
|
builder: F,
|
|
}
|
|
|
|
impl<'s, F: FnMut() -> FnVisitor<'s>> ParallelVisitorBuilder<'s>
|
|
for FnBuilder<F>
|
|
{
|
|
fn build(&mut self) -> Box<dyn ParallelVisitor + 's> {
|
|
let visitor = (self.builder)();
|
|
Box::new(FnVisitorImp { visitor })
|
|
}
|
|
}
|
|
|
|
type FnVisitor<'s> =
|
|
Box<dyn FnMut(Result<DirEntry, Error>) -> WalkState + Send + 's>;
|
|
|
|
struct FnVisitorImp<'s> {
|
|
visitor: FnVisitor<'s>,
|
|
}
|
|
|
|
impl<'s> ParallelVisitor for FnVisitorImp<'s> {
|
|
fn visit(&mut self, entry: Result<DirEntry, Error>) -> WalkState {
|
|
(self.visitor)(entry)
|
|
}
|
|
}
|
|
|
|
/// WalkParallel is a parallel recursive directory iterator over files paths
|
|
/// in one or more directories.
|
|
///
|
|
/// Only file and directory paths matching the rules are returned. By default,
|
|
/// ignore files like `.gitignore` are respected. The precise matching rules
|
|
/// and precedence is explained in the documentation for `WalkBuilder`.
|
|
///
|
|
/// Unlike `Walk`, this uses multiple threads for traversing a directory.
|
|
pub struct WalkParallel {
|
|
paths: vec::IntoIter<PathBuf>,
|
|
ig_root: Ignore,
|
|
max_filesize: Option<u64>,
|
|
max_depth: Option<usize>,
|
|
follow_links: bool,
|
|
same_file_system: bool,
|
|
threads: usize,
|
|
skip: Option<Arc<Handle>>,
|
|
}
|
|
|
|
impl WalkParallel {
|
|
/// Execute the parallel recursive directory iterator. `mkf` is called
|
|
/// for each thread used for iteration. The function produced by `mkf`
|
|
/// is then in turn called for each visited file path.
|
|
pub fn run<'s, F>(self, mkf: F)
|
|
where
|
|
F: FnMut() -> FnVisitor<'s>,
|
|
{
|
|
self.visit(&mut FnBuilder { builder: mkf })
|
|
}
|
|
|
|
/// Execute the parallel recursive directory iterator using a custom
|
|
/// visitor.
|
|
///
|
|
/// The builder given is used to construct a visitor for every thread
|
|
/// used by this traversal. The visitor returned from each builder is then
|
|
/// called for every directory entry seen by that thread.
|
|
///
|
|
/// Typically, creating a custom visitor is useful if you need to perform
|
|
/// some kind of cleanup once traversal is finished. This can be achieved
|
|
/// by implementing `Drop` for your builder (or for your visitor, if you
|
|
/// want to execute cleanup for every thread that is launched).
|
|
///
|
|
/// For example, each visitor might build up a data structure of results
|
|
/// corresponding to the directory entries seen for each thread. Since each
|
|
/// visitor runs on only one thread, this build-up can be done without
|
|
/// synchronization. Then, once traversal is complete, all of the results
|
|
/// can be merged together into a single data structure.
|
|
pub fn visit(mut self, builder: &mut dyn ParallelVisitorBuilder) {
|
|
let threads = self.threads();
|
|
let stack = Arc::new(Mutex::new(vec![]));
|
|
{
|
|
let mut stack = stack.lock().unwrap();
|
|
let mut visitor = builder.build();
|
|
let mut paths = Vec::new().into_iter();
|
|
std::mem::swap(&mut paths, &mut self.paths);
|
|
// Send the initial set of root paths to the pool of workers. Note
|
|
// that we only send directories. For files, we send to them the
|
|
// callback directly.
|
|
for path in paths {
|
|
let (dent, root_device) = if path == Path::new("-") {
|
|
(DirEntry::new_stdin(), None)
|
|
} else {
|
|
let root_device = if !self.same_file_system {
|
|
None
|
|
} else {
|
|
match device_num(&path) {
|
|
Ok(root_device) => Some(root_device),
|
|
Err(err) => {
|
|
let err = Error::Io(err).with_path(path);
|
|
if visitor.visit(Err(err)).is_quit() {
|
|
return;
|
|
}
|
|
continue;
|
|
}
|
|
}
|
|
};
|
|
match DirEntryRaw::from_path(0, path, false) {
|
|
Ok(dent) => {
|
|
(DirEntry::new_raw(dent, None), root_device)
|
|
}
|
|
Err(err) => {
|
|
if visitor.visit(Err(err)).is_quit() {
|
|
return;
|
|
}
|
|
continue;
|
|
}
|
|
}
|
|
};
|
|
stack.push(Message::Work(Work {
|
|
dent: dent,
|
|
ignore: self.ig_root.clone(),
|
|
root_device: root_device,
|
|
}));
|
|
}
|
|
// ... but there's no need to start workers if we don't need them.
|
|
if stack.is_empty() {
|
|
return;
|
|
}
|
|
}
|
|
// Create the workers and then wait for them to finish.
|
|
let quit_now = Arc::new(AtomicBool::new(false));
|
|
let num_pending =
|
|
Arc::new(AtomicUsize::new(stack.lock().unwrap().len()));
|
|
crossbeam_utils::thread::scope(|s| {
|
|
let mut handles = vec![];
|
|
for _ in 0..threads {
|
|
let worker = Worker {
|
|
visitor: builder.build(),
|
|
stack: stack.clone(),
|
|
quit_now: quit_now.clone(),
|
|
num_pending: num_pending.clone(),
|
|
max_depth: self.max_depth,
|
|
max_filesize: self.max_filesize,
|
|
follow_links: self.follow_links,
|
|
skip: self.skip.clone(),
|
|
};
|
|
handles.push(s.spawn(|_| worker.run()));
|
|
}
|
|
for handle in handles {
|
|
handle.join().unwrap();
|
|
}
|
|
})
|
|
.unwrap(); // Pass along panics from threads
|
|
}
|
|
|
|
fn threads(&self) -> usize {
|
|
if self.threads == 0 {
|
|
2
|
|
} else {
|
|
self.threads
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Message is the set of instructions that a worker knows how to process.
|
|
enum Message {
|
|
/// A work item corresponds to a directory that should be descended into.
|
|
/// Work items for entries that should be skipped or ignored should not
|
|
/// be produced.
|
|
Work(Work),
|
|
/// This instruction indicates that the worker should quit.
|
|
Quit,
|
|
}
|
|
|
|
/// A unit of work for each worker to process.
|
|
///
|
|
/// Each unit of work corresponds to a directory that should be descended
|
|
/// into.
|
|
struct Work {
|
|
/// The directory entry.
|
|
dent: DirEntry,
|
|
/// Any ignore matchers that have been built for this directory's parents.
|
|
ignore: Ignore,
|
|
/// The root device number. When present, only files with the same device
|
|
/// number should be considered.
|
|
root_device: Option<u64>,
|
|
}
|
|
|
|
impl Work {
|
|
/// Returns true if and only if this work item is a directory.
|
|
fn is_dir(&self) -> bool {
|
|
self.dent.is_dir()
|
|
}
|
|
|
|
/// Returns true if and only if this work item is a symlink.
|
|
fn is_symlink(&self) -> bool {
|
|
self.dent.file_type().map_or(false, |ft| ft.is_symlink())
|
|
}
|
|
|
|
/// Adds ignore rules for parent directories.
|
|
///
|
|
/// Note that this only applies to entries at depth 0. On all other
|
|
/// entries, this is a no-op.
|
|
fn add_parents(&mut self) -> Option<Error> {
|
|
if self.dent.depth() > 0 {
|
|
return None;
|
|
}
|
|
// At depth 0, the path of this entry is a root path, so we can
|
|
// use it directly to add parent ignore rules.
|
|
let (ig, err) = self.ignore.add_parents(self.dent.path());
|
|
self.ignore = ig;
|
|
err
|
|
}
|
|
|
|
/// Reads the directory contents of this work item and adds ignore
|
|
/// rules for this directory.
|
|
///
|
|
/// If there was a problem with reading the directory contents, then
|
|
/// an error is returned. If there was a problem reading the ignore
|
|
/// rules for this directory, then the error is attached to this
|
|
/// work item's directory entry.
|
|
fn read_dir(&mut self) -> Result<fs::ReadDir, Error> {
|
|
let readdir = match fs::read_dir(self.dent.path()) {
|
|
Ok(readdir) => readdir,
|
|
Err(err) => {
|
|
let err = Error::from(err)
|
|
.with_path(self.dent.path())
|
|
.with_depth(self.dent.depth());
|
|
return Err(err);
|
|
}
|
|
};
|
|
let (ig, err) = self.ignore.add_child(self.dent.path());
|
|
self.ignore = ig;
|
|
self.dent.err = err;
|
|
Ok(readdir)
|
|
}
|
|
}
|
|
|
|
/// A worker is responsible for descending into directories, updating the
|
|
/// ignore matchers, producing new work and invoking the caller's callback.
|
|
///
|
|
/// Note that a worker is *both* a producer and a consumer.
|
|
struct Worker<'s> {
|
|
/// The caller's callback.
|
|
visitor: Box<dyn ParallelVisitor + 's>,
|
|
/// A stack of work to do.
|
|
///
|
|
/// We use a stack instead of a channel because a stack lets us visit
|
|
/// directories in depth first order. This can substantially reduce peak
|
|
/// memory usage by keeping both the number of files path and gitignore
|
|
/// matchers in memory lower.
|
|
stack: Arc<Mutex<Vec<Message>>>,
|
|
/// Whether all workers should terminate at the next opportunity. Note
|
|
/// that we need this because we don't want other `Work` to be done after
|
|
/// we quit. We wouldn't need this if have a priority channel.
|
|
quit_now: Arc<AtomicBool>,
|
|
/// The number of outstanding work items.
|
|
num_pending: Arc<AtomicUsize>,
|
|
/// The maximum depth of directories to descend. A value of `0` means no
|
|
/// descension at all.
|
|
max_depth: Option<usize>,
|
|
/// The maximum size a searched file can be (in bytes). If a file exceeds
|
|
/// this size it will be skipped.
|
|
max_filesize: Option<u64>,
|
|
/// Whether to follow symbolic links or not. When this is enabled, loop
|
|
/// detection is performed.
|
|
follow_links: bool,
|
|
/// A file handle to skip, currently is either `None` or stdout, if it's
|
|
/// a file and it has been requested to skip files identical to stdout.
|
|
skip: Option<Arc<Handle>>,
|
|
}
|
|
|
|
impl<'s> Worker<'s> {
|
|
/// Runs this worker until there is no more work left to do.
|
|
///
|
|
/// The worker will call the caller's callback for all entries that aren't
|
|
/// skipped by the ignore matcher.
|
|
fn run(mut self) {
|
|
while let Some(work) = self.get_work() {
|
|
if let WalkState::Quit = self.run_one(work) {
|
|
self.quit_now();
|
|
}
|
|
self.work_done();
|
|
}
|
|
}
|
|
|
|
fn run_one(&mut self, mut work: Work) -> WalkState {
|
|
// If the work is not a directory, then we can just execute the
|
|
// caller's callback immediately and move on.
|
|
if work.is_symlink() || !work.is_dir() {
|
|
return self.visitor.visit(Ok(work.dent));
|
|
}
|
|
if let Some(err) = work.add_parents() {
|
|
let state = self.visitor.visit(Err(err));
|
|
if state.is_quit() {
|
|
return state;
|
|
}
|
|
}
|
|
|
|
let descend = if let Some(root_device) = work.root_device {
|
|
match is_same_file_system(root_device, work.dent.path()) {
|
|
Ok(true) => true,
|
|
Ok(false) => false,
|
|
Err(err) => {
|
|
let state = self.visitor.visit(Err(err));
|
|
if state.is_quit() {
|
|
return state;
|
|
}
|
|
false
|
|
}
|
|
}
|
|
} else {
|
|
true
|
|
};
|
|
|
|
// Try to read the directory first before we transfer ownership
|
|
// to the provided closure. Do not unwrap it immediately, though,
|
|
// as we may receive an `Err` value e.g. in the case when we do not
|
|
// have sufficient read permissions to list the directory.
|
|
// In that case we still want to provide the closure with a valid
|
|
// entry before passing the error value.
|
|
let readdir = work.read_dir();
|
|
let depth = work.dent.depth();
|
|
let state = self.visitor.visit(Ok(work.dent));
|
|
if !state.is_continue() {
|
|
return state;
|
|
}
|
|
if !descend {
|
|
return WalkState::Skip;
|
|
}
|
|
|
|
let readdir = match readdir {
|
|
Ok(readdir) => readdir,
|
|
Err(err) => {
|
|
return self.visitor.visit(Err(err));
|
|
}
|
|
};
|
|
|
|
if self.max_depth.map_or(false, |max| depth >= max) {
|
|
return WalkState::Skip;
|
|
}
|
|
for result in readdir {
|
|
let state = self.generate_work(
|
|
&work.ignore,
|
|
depth + 1,
|
|
work.root_device,
|
|
result,
|
|
);
|
|
if state.is_quit() {
|
|
return state;
|
|
}
|
|
}
|
|
WalkState::Continue
|
|
}
|
|
|
|
/// Decides whether to submit the given directory entry as a file to
|
|
/// search.
|
|
///
|
|
/// If the entry is a path that should be ignored, then this is a no-op.
|
|
/// Otherwise, the entry is pushed on to the queue. (The actual execution
|
|
/// of the callback happens in `run_one`.)
|
|
///
|
|
/// If an error occurs while reading the entry, then it is sent to the
|
|
/// caller's callback.
|
|
///
|
|
/// `ig` is the `Ignore` matcher for the parent directory. `depth` should
|
|
/// be the depth of this entry. `result` should be the item yielded by
|
|
/// a directory iterator.
|
|
fn generate_work(
|
|
&mut self,
|
|
ig: &Ignore,
|
|
depth: usize,
|
|
root_device: Option<u64>,
|
|
result: Result<fs::DirEntry, io::Error>,
|
|
) -> WalkState {
|
|
let fs_dent = match result {
|
|
Ok(fs_dent) => fs_dent,
|
|
Err(err) => {
|
|
return self
|
|
.visitor
|
|
.visit(Err(Error::from(err).with_depth(depth)));
|
|
}
|
|
};
|
|
let mut dent = match DirEntryRaw::from_entry(depth, &fs_dent) {
|
|
Ok(dent) => DirEntry::new_raw(dent, None),
|
|
Err(err) => {
|
|
return self.visitor.visit(Err(err));
|
|
}
|
|
};
|
|
let is_symlink = dent.file_type().map_or(false, |ft| ft.is_symlink());
|
|
if self.follow_links && is_symlink {
|
|
let path = dent.path().to_path_buf();
|
|
dent = match DirEntryRaw::from_path(depth, path, true) {
|
|
Ok(dent) => DirEntry::new_raw(dent, None),
|
|
Err(err) => {
|
|
return self.visitor.visit(Err(err));
|
|
}
|
|
};
|
|
if dent.is_dir() {
|
|
if let Err(err) = check_symlink_loop(ig, dent.path(), depth) {
|
|
return self.visitor.visit(Err(err));
|
|
}
|
|
}
|
|
}
|
|
if let Some(ref stdout) = self.skip {
|
|
let is_stdout = match path_equals(&dent, stdout) {
|
|
Ok(is_stdout) => is_stdout,
|
|
Err(err) => return self.visitor.visit(Err(err)),
|
|
};
|
|
if is_stdout {
|
|
return WalkState::Continue;
|
|
}
|
|
}
|
|
let should_skip_path = should_skip_entry(ig, &dent);
|
|
let should_skip_filesize =
|
|
if self.max_filesize.is_some() && !dent.is_dir() {
|
|
skip_filesize(
|
|
self.max_filesize.unwrap(),
|
|
dent.path(),
|
|
&dent.metadata().ok(),
|
|
)
|
|
} else {
|
|
false
|
|
};
|
|
|
|
if !should_skip_path && !should_skip_filesize {
|
|
self.send(Work { dent, ignore: ig.clone(), root_device });
|
|
}
|
|
WalkState::Continue
|
|
}
|
|
|
|
/// Returns the next directory to descend into.
|
|
///
|
|
/// If all work has been exhausted, then this returns None. The worker
|
|
/// should then subsequently quit.
|
|
fn get_work(&mut self) -> Option<Work> {
|
|
let mut value = self.recv();
|
|
loop {
|
|
// Simulate a priority channel: If quit_now flag is set, we can
|
|
// receive only quit messages.
|
|
if self.is_quit_now() {
|
|
value = Some(Message::Quit)
|
|
}
|
|
match value {
|
|
Some(Message::Work(work)) => {
|
|
return Some(work);
|
|
}
|
|
Some(Message::Quit) => {
|
|
// Repeat quit message to wake up sleeping threads, if
|
|
// any. The domino effect will ensure that every thread
|
|
// will quit.
|
|
self.send_quit();
|
|
return None;
|
|
}
|
|
None => {
|
|
// Once num_pending reaches 0, it is impossible for it to
|
|
// ever increase again. Namely, it only reaches 0 once
|
|
// all jobs have run such that no jobs have produced more
|
|
// work. We have this guarantee because num_pending is
|
|
// always incremented before each job is submitted and only
|
|
// decremented once each job is completely finished.
|
|
// Therefore, if this reaches zero, then there can be no
|
|
// other job running.
|
|
if self.num_pending() == 0 {
|
|
// Every other thread is blocked at the next recv().
|
|
// Send the initial quit message and quit.
|
|
self.send_quit();
|
|
return None;
|
|
}
|
|
// Wait for next `Work` or `Quit` message.
|
|
loop {
|
|
if let Some(v) = self.recv() {
|
|
value = Some(v);
|
|
break;
|
|
}
|
|
// Our stack isn't blocking. Instead of burning the
|
|
// CPU waiting, we let the thread sleep for a bit. In
|
|
// general, this tends to only occur once the search is
|
|
// approaching termination.
|
|
thread::sleep(Duration::from_millis(1));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Indicates that all workers should quit immediately.
|
|
fn quit_now(&self) {
|
|
self.quit_now.store(true, Ordering::SeqCst);
|
|
}
|
|
|
|
/// Returns true if this worker should quit immediately.
|
|
fn is_quit_now(&self) -> bool {
|
|
self.quit_now.load(Ordering::SeqCst)
|
|
}
|
|
|
|
/// Returns the number of pending jobs.
|
|
fn num_pending(&self) -> usize {
|
|
self.num_pending.load(Ordering::SeqCst)
|
|
}
|
|
|
|
/// Send work.
|
|
fn send(&self, work: Work) {
|
|
self.num_pending.fetch_add(1, Ordering::SeqCst);
|
|
let mut stack = self.stack.lock().unwrap();
|
|
stack.push(Message::Work(work));
|
|
}
|
|
|
|
/// Send a quit message.
|
|
fn send_quit(&self) {
|
|
let mut stack = self.stack.lock().unwrap();
|
|
stack.push(Message::Quit);
|
|
}
|
|
|
|
/// Receive work.
|
|
fn recv(&self) -> Option<Message> {
|
|
let mut stack = self.stack.lock().unwrap();
|
|
stack.pop()
|
|
}
|
|
|
|
/// Signal that work has been received.
|
|
fn work_done(&self) {
|
|
self.num_pending.fetch_sub(1, Ordering::SeqCst);
|
|
}
|
|
}
|
|
|
|
fn check_symlink_loop(
|
|
ig_parent: &Ignore,
|
|
child_path: &Path,
|
|
child_depth: usize,
|
|
) -> Result<(), Error> {
|
|
let hchild = Handle::from_path(child_path).map_err(|err| {
|
|
Error::from(err).with_path(child_path).with_depth(child_depth)
|
|
})?;
|
|
for ig in ig_parent.parents().take_while(|ig| !ig.is_absolute_parent()) {
|
|
let h = Handle::from_path(ig.path()).map_err(|err| {
|
|
Error::from(err).with_path(child_path).with_depth(child_depth)
|
|
})?;
|
|
if hchild == h {
|
|
return Err(Error::Loop {
|
|
ancestor: ig.path().to_path_buf(),
|
|
child: child_path.to_path_buf(),
|
|
}
|
|
.with_depth(child_depth));
|
|
}
|
|
}
|
|
Ok(())
|
|
}
|
|
|
|
// Before calling this function, make sure that you ensure that is really
|
|
// necessary as the arguments imply a file stat.
|
|
fn skip_filesize(
|
|
max_filesize: u64,
|
|
path: &Path,
|
|
ent: &Option<Metadata>,
|
|
) -> bool {
|
|
let filesize = match *ent {
|
|
Some(ref md) => Some(md.len()),
|
|
None => None,
|
|
};
|
|
|
|
if let Some(fs) = filesize {
|
|
if fs > max_filesize {
|
|
debug!("ignoring {}: {} bytes", path.display(), fs);
|
|
true
|
|
} else {
|
|
false
|
|
}
|
|
} else {
|
|
false
|
|
}
|
|
}
|
|
|
|
fn should_skip_entry(ig: &Ignore, dent: &DirEntry) -> bool {
|
|
let m = ig.matched_dir_entry(dent);
|
|
if m.is_ignore() {
|
|
debug!("ignoring {}: {:?}", dent.path().display(), m);
|
|
true
|
|
} else if m.is_whitelist() {
|
|
debug!("whitelisting {}: {:?}", dent.path().display(), m);
|
|
false
|
|
} else {
|
|
false
|
|
}
|
|
}
|
|
|
|
/// Returns a handle to stdout for filtering search.
|
|
///
|
|
/// A handle is returned if and only if stdout is being redirected to a file.
|
|
/// The handle returned corresponds to that file.
|
|
///
|
|
/// This can be used to ensure that we do not attempt to search a file that we
|
|
/// may also be writing to.
|
|
fn stdout_handle() -> Option<Handle> {
|
|
let h = match Handle::stdout() {
|
|
Err(_) => return None,
|
|
Ok(h) => h,
|
|
};
|
|
let md = match h.as_file().metadata() {
|
|
Err(_) => return None,
|
|
Ok(md) => md,
|
|
};
|
|
if !md.is_file() {
|
|
return None;
|
|
}
|
|
Some(h)
|
|
}
|
|
|
|
/// Returns true if and only if the given directory entry is believed to be
|
|
/// equivalent to the given handle. If there was a problem querying the path
|
|
/// for information to determine equality, then that error is returned.
|
|
fn path_equals(dent: &DirEntry, handle: &Handle) -> Result<bool, Error> {
|
|
#[cfg(unix)]
|
|
fn never_equal(dent: &DirEntry, handle: &Handle) -> bool {
|
|
dent.ino() != Some(handle.ino())
|
|
}
|
|
|
|
#[cfg(not(unix))]
|
|
fn never_equal(_: &DirEntry, _: &Handle) -> bool {
|
|
false
|
|
}
|
|
|
|
// If we know for sure that these two things aren't equal, then avoid
|
|
// the costly extra stat call to determine equality.
|
|
if dent.is_stdin() || never_equal(dent, handle) {
|
|
return Ok(false);
|
|
}
|
|
Handle::from_path(dent.path())
|
|
.map(|h| &h == handle)
|
|
.map_err(|err| Error::Io(err).with_path(dent.path()))
|
|
}
|
|
|
|
/// Returns true if the given walkdir entry corresponds to a directory.
|
|
///
|
|
/// This is normally just `dent.file_type().is_dir()`, but when we aren't
|
|
/// following symlinks, the root directory entry may be a symlink to a
|
|
/// directory that we *do* follow---by virtue of it being specified by the user
|
|
/// explicitly. In that case, we need to follow the symlink and query whether
|
|
/// it's a directory or not. But we only do this for root entries to avoid an
|
|
/// additional stat check in most cases.
|
|
fn walkdir_is_dir(dent: &walkdir::DirEntry) -> bool {
|
|
if dent.file_type().is_dir() {
|
|
return true;
|
|
}
|
|
if !dent.file_type().is_symlink() || dent.depth() > 0 {
|
|
return false;
|
|
}
|
|
dent.path().metadata().ok().map_or(false, |md| md.file_type().is_dir())
|
|
}
|
|
|
|
/// Returns true if and only if the given path is on the same device as the
|
|
/// given root device.
|
|
fn is_same_file_system(root_device: u64, path: &Path) -> Result<bool, Error> {
|
|
let dent_device =
|
|
device_num(path).map_err(|err| Error::Io(err).with_path(path))?;
|
|
Ok(root_device == dent_device)
|
|
}
|
|
|
|
#[cfg(unix)]
|
|
fn device_num<P: AsRef<Path>>(path: P) -> io::Result<u64> {
|
|
use std::os::unix::fs::MetadataExt;
|
|
|
|
path.as_ref().metadata().map(|md| md.dev())
|
|
}
|
|
|
|
#[cfg(windows)]
|
|
fn device_num<P: AsRef<Path>>(path: P) -> io::Result<u64> {
|
|
use winapi_util::{file, Handle};
|
|
|
|
let h = Handle::from_path_any(path)?;
|
|
file::information(h).map(|info| info.volume_serial_number())
|
|
}
|
|
|
|
#[cfg(not(any(unix, windows)))]
|
|
fn device_num<P: AsRef<Path>>(_: P) -> io::Result<u64> {
|
|
Err(io::Error::new(
|
|
io::ErrorKind::Other,
|
|
"walkdir: same_file_system option not supported on this platform",
|
|
))
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use std::fs::{self, File};
|
|
use std::io::Write;
|
|
use std::path::Path;
|
|
use std::sync::{Arc, Mutex};
|
|
|
|
use super::{DirEntry, WalkBuilder, WalkState};
|
|
use tests::TempDir;
|
|
|
|
fn wfile<P: AsRef<Path>>(path: P, contents: &str) {
|
|
let mut file = File::create(path).unwrap();
|
|
file.write_all(contents.as_bytes()).unwrap();
|
|
}
|
|
|
|
fn wfile_size<P: AsRef<Path>>(path: P, size: u64) {
|
|
let file = File::create(path).unwrap();
|
|
file.set_len(size).unwrap();
|
|
}
|
|
|
|
#[cfg(unix)]
|
|
fn symlink<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) {
|
|
use std::os::unix::fs::symlink;
|
|
symlink(src, dst).unwrap();
|
|
}
|
|
|
|
fn mkdirp<P: AsRef<Path>>(path: P) {
|
|
fs::create_dir_all(path).unwrap();
|
|
}
|
|
|
|
fn normal_path(unix: &str) -> String {
|
|
if cfg!(windows) {
|
|
unix.replace("\\", "/")
|
|
} else {
|
|
unix.to_string()
|
|
}
|
|
}
|
|
|
|
fn walk_collect(prefix: &Path, builder: &WalkBuilder) -> Vec<String> {
|
|
let mut paths = vec![];
|
|
for result in builder.build() {
|
|
let dent = match result {
|
|
Err(_) => continue,
|
|
Ok(dent) => dent,
|
|
};
|
|
let path = dent.path().strip_prefix(prefix).unwrap();
|
|
if path.as_os_str().is_empty() {
|
|
continue;
|
|
}
|
|
paths.push(normal_path(path.to_str().unwrap()));
|
|
}
|
|
paths.sort();
|
|
paths
|
|
}
|
|
|
|
fn walk_collect_parallel(
|
|
prefix: &Path,
|
|
builder: &WalkBuilder,
|
|
) -> Vec<String> {
|
|
let mut paths = vec![];
|
|
for dent in walk_collect_entries_parallel(builder) {
|
|
let path = dent.path().strip_prefix(prefix).unwrap();
|
|
if path.as_os_str().is_empty() {
|
|
continue;
|
|
}
|
|
paths.push(normal_path(path.to_str().unwrap()));
|
|
}
|
|
paths.sort();
|
|
paths
|
|
}
|
|
|
|
fn walk_collect_entries_parallel(builder: &WalkBuilder) -> Vec<DirEntry> {
|
|
let dents = Arc::new(Mutex::new(vec![]));
|
|
builder.build_parallel().run(|| {
|
|
let dents = dents.clone();
|
|
Box::new(move |result| {
|
|
if let Ok(dent) = result {
|
|
dents.lock().unwrap().push(dent);
|
|
}
|
|
WalkState::Continue
|
|
})
|
|
});
|
|
|
|
let dents = dents.lock().unwrap();
|
|
dents.to_vec()
|
|
}
|
|
|
|
fn mkpaths(paths: &[&str]) -> Vec<String> {
|
|
let mut paths: Vec<_> = paths.iter().map(|s| s.to_string()).collect();
|
|
paths.sort();
|
|
paths
|
|
}
|
|
|
|
fn tmpdir() -> TempDir {
|
|
TempDir::new().unwrap()
|
|
}
|
|
|
|
fn assert_paths(prefix: &Path, builder: &WalkBuilder, expected: &[&str]) {
|
|
let got = walk_collect(prefix, builder);
|
|
assert_eq!(got, mkpaths(expected), "single threaded");
|
|
let got = walk_collect_parallel(prefix, builder);
|
|
assert_eq!(got, mkpaths(expected), "parallel");
|
|
}
|
|
|
|
#[test]
|
|
fn no_ignores() {
|
|
let td = tmpdir();
|
|
mkdirp(td.path().join("a/b/c"));
|
|
mkdirp(td.path().join("x/y"));
|
|
wfile(td.path().join("a/b/foo"), "");
|
|
wfile(td.path().join("x/y/foo"), "");
|
|
|
|
assert_paths(
|
|
td.path(),
|
|
&WalkBuilder::new(td.path()),
|
|
&["x", "x/y", "x/y/foo", "a", "a/b", "a/b/foo", "a/b/c"],
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn custom_ignore() {
|
|
let td = tmpdir();
|
|
let custom_ignore = ".customignore";
|
|
mkdirp(td.path().join("a"));
|
|
wfile(td.path().join(custom_ignore), "foo");
|
|
wfile(td.path().join("foo"), "");
|
|
wfile(td.path().join("a/foo"), "");
|
|
wfile(td.path().join("bar"), "");
|
|
wfile(td.path().join("a/bar"), "");
|
|
|
|
let mut builder = WalkBuilder::new(td.path());
|
|
builder.add_custom_ignore_filename(&custom_ignore);
|
|
assert_paths(td.path(), &builder, &["bar", "a", "a/bar"]);
|
|
}
|
|
|
|
#[test]
|
|
fn custom_ignore_exclusive_use() {
|
|
let td = tmpdir();
|
|
let custom_ignore = ".customignore";
|
|
mkdirp(td.path().join("a"));
|
|
wfile(td.path().join(custom_ignore), "foo");
|
|
wfile(td.path().join("foo"), "");
|
|
wfile(td.path().join("a/foo"), "");
|
|
wfile(td.path().join("bar"), "");
|
|
wfile(td.path().join("a/bar"), "");
|
|
|
|
let mut builder = WalkBuilder::new(td.path());
|
|
builder.ignore(false);
|
|
builder.git_ignore(false);
|
|
builder.git_global(false);
|
|
builder.git_exclude(false);
|
|
builder.add_custom_ignore_filename(&custom_ignore);
|
|
assert_paths(td.path(), &builder, &["bar", "a", "a/bar"]);
|
|
}
|
|
|
|
#[test]
|
|
fn gitignore() {
|
|
let td = tmpdir();
|
|
mkdirp(td.path().join(".git"));
|
|
mkdirp(td.path().join("a"));
|
|
wfile(td.path().join(".gitignore"), "foo");
|
|
wfile(td.path().join("foo"), "");
|
|
wfile(td.path().join("a/foo"), "");
|
|
wfile(td.path().join("bar"), "");
|
|
wfile(td.path().join("a/bar"), "");
|
|
|
|
assert_paths(
|
|
td.path(),
|
|
&WalkBuilder::new(td.path()),
|
|
&["bar", "a", "a/bar"],
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn explicit_ignore() {
|
|
let td = tmpdir();
|
|
let igpath = td.path().join(".not-an-ignore");
|
|
mkdirp(td.path().join("a"));
|
|
wfile(&igpath, "foo");
|
|
wfile(td.path().join("foo"), "");
|
|
wfile(td.path().join("a/foo"), "");
|
|
wfile(td.path().join("bar"), "");
|
|
wfile(td.path().join("a/bar"), "");
|
|
|
|
let mut builder = WalkBuilder::new(td.path());
|
|
assert!(builder.add_ignore(&igpath).is_none());
|
|
assert_paths(td.path(), &builder, &["bar", "a", "a/bar"]);
|
|
}
|
|
|
|
#[test]
|
|
fn explicit_ignore_exclusive_use() {
|
|
let td = tmpdir();
|
|
let igpath = td.path().join(".not-an-ignore");
|
|
mkdirp(td.path().join("a"));
|
|
wfile(&igpath, "foo");
|
|
wfile(td.path().join("foo"), "");
|
|
wfile(td.path().join("a/foo"), "");
|
|
wfile(td.path().join("bar"), "");
|
|
wfile(td.path().join("a/bar"), "");
|
|
|
|
let mut builder = WalkBuilder::new(td.path());
|
|
builder.standard_filters(false);
|
|
assert!(builder.add_ignore(&igpath).is_none());
|
|
assert_paths(
|
|
td.path(),
|
|
&builder,
|
|
&[".not-an-ignore", "bar", "a", "a/bar"],
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn gitignore_parent() {
|
|
let td = tmpdir();
|
|
mkdirp(td.path().join(".git"));
|
|
mkdirp(td.path().join("a"));
|
|
wfile(td.path().join(".gitignore"), "foo");
|
|
wfile(td.path().join("a/foo"), "");
|
|
wfile(td.path().join("a/bar"), "");
|
|
|
|
let root = td.path().join("a");
|
|
assert_paths(&root, &WalkBuilder::new(&root), &["bar"]);
|
|
}
|
|
|
|
#[test]
|
|
fn max_depth() {
|
|
let td = tmpdir();
|
|
mkdirp(td.path().join("a/b/c"));
|
|
wfile(td.path().join("foo"), "");
|
|
wfile(td.path().join("a/foo"), "");
|
|
wfile(td.path().join("a/b/foo"), "");
|
|
wfile(td.path().join("a/b/c/foo"), "");
|
|
|
|
let mut builder = WalkBuilder::new(td.path());
|
|
assert_paths(
|
|
td.path(),
|
|
&builder,
|
|
&["a", "a/b", "a/b/c", "foo", "a/foo", "a/b/foo", "a/b/c/foo"],
|
|
);
|
|
assert_paths(td.path(), builder.max_depth(Some(0)), &[]);
|
|
assert_paths(td.path(), builder.max_depth(Some(1)), &["a", "foo"]);
|
|
assert_paths(
|
|
td.path(),
|
|
builder.max_depth(Some(2)),
|
|
&["a", "a/b", "foo", "a/foo"],
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn max_filesize() {
|
|
let td = tmpdir();
|
|
mkdirp(td.path().join("a/b"));
|
|
wfile_size(td.path().join("foo"), 0);
|
|
wfile_size(td.path().join("bar"), 400);
|
|
wfile_size(td.path().join("baz"), 600);
|
|
wfile_size(td.path().join("a/foo"), 600);
|
|
wfile_size(td.path().join("a/bar"), 500);
|
|
wfile_size(td.path().join("a/baz"), 200);
|
|
|
|
let mut builder = WalkBuilder::new(td.path());
|
|
assert_paths(
|
|
td.path(),
|
|
&builder,
|
|
&["a", "a/b", "foo", "bar", "baz", "a/foo", "a/bar", "a/baz"],
|
|
);
|
|
assert_paths(
|
|
td.path(),
|
|
builder.max_filesize(Some(0)),
|
|
&["a", "a/b", "foo"],
|
|
);
|
|
assert_paths(
|
|
td.path(),
|
|
builder.max_filesize(Some(500)),
|
|
&["a", "a/b", "foo", "bar", "a/bar", "a/baz"],
|
|
);
|
|
assert_paths(
|
|
td.path(),
|
|
builder.max_filesize(Some(50000)),
|
|
&["a", "a/b", "foo", "bar", "baz", "a/foo", "a/bar", "a/baz"],
|
|
);
|
|
}
|
|
|
|
#[cfg(unix)] // because symlinks on windows are weird
|
|
#[test]
|
|
fn symlinks() {
|
|
let td = tmpdir();
|
|
mkdirp(td.path().join("a/b"));
|
|
symlink(td.path().join("a/b"), td.path().join("z"));
|
|
wfile(td.path().join("a/b/foo"), "");
|
|
|
|
let mut builder = WalkBuilder::new(td.path());
|
|
assert_paths(td.path(), &builder, &["a", "a/b", "a/b/foo", "z"]);
|
|
assert_paths(
|
|
td.path(),
|
|
&builder.follow_links(true),
|
|
&["a", "a/b", "a/b/foo", "z", "z/foo"],
|
|
);
|
|
}
|
|
|
|
#[cfg(unix)] // because symlinks on windows are weird
|
|
#[test]
|
|
fn first_path_not_symlink() {
|
|
let td = tmpdir();
|
|
mkdirp(td.path().join("foo"));
|
|
|
|
let dents = WalkBuilder::new(td.path().join("foo"))
|
|
.build()
|
|
.into_iter()
|
|
.collect::<Result<Vec<_>, _>>()
|
|
.unwrap();
|
|
assert_eq!(1, dents.len());
|
|
assert!(!dents[0].path_is_symlink());
|
|
|
|
let dents = walk_collect_entries_parallel(&WalkBuilder::new(
|
|
td.path().join("foo"),
|
|
));
|
|
assert_eq!(1, dents.len());
|
|
assert!(!dents[0].path_is_symlink());
|
|
}
|
|
|
|
#[cfg(unix)] // because symlinks on windows are weird
|
|
#[test]
|
|
fn symlink_loop() {
|
|
let td = tmpdir();
|
|
mkdirp(td.path().join("a/b"));
|
|
symlink(td.path().join("a"), td.path().join("a/b/c"));
|
|
|
|
let mut builder = WalkBuilder::new(td.path());
|
|
assert_paths(td.path(), &builder, &["a", "a/b", "a/b/c"]);
|
|
assert_paths(td.path(), &builder.follow_links(true), &["a", "a/b"]);
|
|
}
|
|
|
|
// It's a little tricky to test the 'same_file_system' option since
|
|
// we need an environment with more than one file system. We adopt a
|
|
// heuristic where /sys is typically a distinct volume on Linux and roll
|
|
// with that.
|
|
#[test]
|
|
#[cfg(target_os = "linux")]
|
|
fn same_file_system() {
|
|
use super::device_num;
|
|
|
|
// If for some reason /sys doesn't exist or isn't a directory, just
|
|
// skip this test.
|
|
if !Path::new("/sys").is_dir() {
|
|
return;
|
|
}
|
|
|
|
// If our test directory actually isn't a different volume from /sys,
|
|
// then this test is meaningless and we shouldn't run it.
|
|
let td = tmpdir();
|
|
if device_num(td.path()).unwrap() == device_num("/sys").unwrap() {
|
|
return;
|
|
}
|
|
|
|
mkdirp(td.path().join("same_file"));
|
|
symlink("/sys", td.path().join("same_file").join("alink"));
|
|
|
|
// Create a symlink to sys and enable following symlinks. If the
|
|
// same_file_system option doesn't work, then this probably will hit a
|
|
// permission error. Otherwise, it should just skip over the symlink
|
|
// completely.
|
|
let mut builder = WalkBuilder::new(td.path());
|
|
builder.follow_links(true).same_file_system(true);
|
|
assert_paths(td.path(), &builder, &["same_file", "same_file/alink"]);
|
|
}
|
|
|
|
#[cfg(target_os = "linux")]
|
|
#[test]
|
|
fn no_read_permissions() {
|
|
let dir_path = Path::new("/root");
|
|
|
|
// There's no /etc/sudoers.d, skip the test.
|
|
if !dir_path.is_dir() {
|
|
return;
|
|
}
|
|
// We're the root, so the test won't check what we want it to.
|
|
if fs::read_dir(&dir_path).is_ok() {
|
|
return;
|
|
}
|
|
|
|
// Check that we can't descend but get an entry for the parent dir.
|
|
let builder = WalkBuilder::new(&dir_path);
|
|
assert_paths(dir_path.parent().unwrap(), &builder, &["root"]);
|
|
}
|
|
}
|