rust/ripgrep
1
0
Fork 0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-04-14 00:58:43 +02:00
Code Issues Releases Activity

ignore: fix reference cycle for compiled matchers

Browse Source 
It looks like there is a reference cycle caused by the compiled
matchers (compiled HashMap holds ref to Ignore and Ignore holds ref
to HashMap). Using weak refs fixes issue #2690 in my test project.
Also confirmed via before and after when profiling the code, see the
attached screenshots in #2692.

Fixes #2690
This commit is contained in:
fe9lix 2023-12-20 18:34:42 +01:00 committed by Andrew Gallant
parent 67dd809a80
commit b9c774937f
2 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
CHANGELOG.md
View File

@ -2,6 +2,11 @@
============ ============
This is a minor release with a few small new features and bug fixes. This is a minor release with a few small new features and bug fixes.
Bug fixes:
* [BUG #2664](https://github.com/BurntSushi/ripgrep/issues/2690):
Fix unbounded memory growth in the `ignore` crate.
Feature enhancements: Feature enhancements:
* [FEATURE #2684](https://github.com/BurntSushi/ripgrep/issues/2684): * [FEATURE #2684](https://github.com/BurntSushi/ripgrep/issues/2684):

20
crates/ignore/src/dir.rs
View File

@ -19,7 +19,7 @@ use std::{
fs::{File, FileType}, fs::{File, FileType},
io::{self, BufRead}, io::{self, BufRead},
path::{Path, PathBuf}, path::{Path, PathBuf},
sync::{Arc, RwLock}, sync::{Arc, RwLock, Weak},
}; };
use crate::{ use crate::{
@ -101,7 +101,7 @@ struct IgnoreInner {
/// Note that this is never used during matching, only when adding new /// Note that this is never used during matching, only when adding new
/// parent directory matchers. This avoids needing to rebuild glob sets for /// parent directory matchers. This avoids needing to rebuild glob sets for
/// parent directories if many paths are being searched. /// parent directories if many paths are being searched.
compiled: Arc<RwLock<HashMap<OsString, Ignore>>>, compiled: Arc<RwLock<HashMap<OsString, Weak<IgnoreInner>>>>,
/// The path to the directory that this matcher was built from. /// The path to the directory that this matcher was built from.
dir: PathBuf, dir: PathBuf,
/// An override matcher (default is empty). /// An override matcher (default is empty).
@ -200,9 +200,11 @@ impl Ignore {
let mut ig = self.clone(); let mut ig = self.clone();
for parent in parents.into_iter().rev() { for parent in parents.into_iter().rev() {
let mut compiled = self.0.compiled.write().unwrap(); let mut compiled = self.0.compiled.write().unwrap();
if let Some(prebuilt) = compiled.get(parent.as_os_str()) { if let Some(weak) = compiled.get(parent.as_os_str()) {
ig = prebuilt.clone(); if let Some(prebuilt) = weak.upgrade() {
continue; ig = Ignore(prebuilt);
continue;
}
} }
let (mut igtmp, err) = ig.add_child_path(parent); let (mut igtmp, err) = ig.add_child_path(parent);
errs.maybe_push(err); errs.maybe_push(err);
@ -214,8 +216,12 @@ impl Ignore {
} else { } else {
false false
}; };
ig = Ignore(Arc::new(igtmp)); let ig_arc = Arc::new(igtmp);
compiled.insert(parent.as_os_str().to_os_string(), ig.clone()); ig = Ignore(ig_arc.clone());
compiled.insert(
parent.as_os_str().to_os_string(),
Arc::downgrade(&ig_arc),
);
} }
(ig, errs.into_error_option()) (ig, errs.into_error_option())
} }