Skip to content
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.

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

Add hardlink tracking, and an option to disable it #37

Merged
3 commits merged into from
Feb 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 0 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,10 +172,8 @@ Thanks to [jwalk][jwalk], all there was left to do is to write a command-line in
### Limitations

* Interactive mode only looks good in dark terminals (see [this issue](https://github.com/Byron/dua-cli/issues/13))
* _Hard links_ are not understood, thus hard-linked files will possibly be counted multiple times.
* _Symlinks_ are followed and we obtain the logical size of the file they point to. Ideally, we only
count their actual size.
* _logical filesize_ is used instead of computed or estimating actual size on disk.
* _easy fix_: file names in main window are not truncated if too large. They are cut off on the right.
* There are plenty of examples in `tests/fixtures` which don't render correctly in interactive mode.
This can be due to graphemes not interpreted correctly. With Chinese characters for instance,
Expand Down
5 changes: 3 additions & 2 deletions src/aggregate.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::{WalkOptions, WalkResult};
use crate::{InodeFilter, WalkOptions, WalkResult};
use failure::Error;
use std::borrow::Cow;
use std::{fmt, io, path::Path};
Expand All @@ -20,6 +20,7 @@ pub fn aggregate(
let mut total = 0;
let mut num_roots = 0;
let mut aggregates = Vec::new();
let mut inodes = InodeFilter::default();
for path in paths.into_iter() {
num_roots += 1;
let mut num_bytes = 0u64;
Expand All @@ -29,7 +30,7 @@ pub fn aggregate(
match entry {
Ok(entry) => {
let file_size = match entry.metadata {
Some(Ok(ref m)) if !m.is_dir() => {
Some(Ok(ref m)) if !m.is_dir() && (options.count_links || inodes.add(m)) => {
if options.apparent_size {
m.len()
} else {
Expand Down
1 change: 1 addition & 0 deletions src/common.rs
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ pub struct WalkOptions {
/// for more information.
pub threads: usize,
pub byte_format: ByteFormat,
pub count_links: bool,
pub apparent_size: bool,
pub color: Color,
pub sorting: TraversalSorting,
Expand Down
75 changes: 75 additions & 0 deletions src/inodefilter.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
#![cfg_attr(windows, feature(windows_by_handle))]

use std::collections::HashMap;

#[derive(Debug, Default, Clone)]
pub struct InodeFilter {
inner: HashMap<u64, u64>,
}

impl InodeFilter {
#[cfg(unix)]
pub fn add(&mut self, metadata: &std::fs::Metadata) -> bool {
use std::os::unix::fs::MetadataExt;

self.add_inode(metadata.ino(), metadata.nlink())
}

#[cfg(windows)]
pub fn add(&mut self, metadata: &std::fs::Metadata) -> bool {
use std::os::windows::fs::MetadataExt;

if let (Some(inode), Some(nlinks)) = (metadata.file_index(), metadata.number_of_links()) {
self.add_inode(inode, nlinks as u64)
} else {
true
}
}

#[cfg(not(any(unix, windows)))]
pub fn add(&mut self, metadata: &std::fs::Metadata) -> bool {
true
}

pub fn add_inode(&mut self, inode: u64, nlinks: u64) -> bool {
if nlinks <= 1 {
return true;
}

match self.inner.get_mut(&inode) {
Some(count) => {
*count -= 1;

if *count == 0 {
self.inner.remove(&inode);
}

false
}
None => {
self.inner.insert(inode, nlinks - 1);
true
}
}
}
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn it_filters_inodes() {
let mut inodes = InodeFilter::default();

assert!(inodes.add_inode(1, 2));
assert!(!inodes.add_inode(1, 2));

assert!(inodes.add_inode(1, 3));
assert!(!inodes.add_inode(1, 3));
assert!(!inodes.add_inode(1, 3));

assert!(inodes.add_inode(1, 1));
assert!(inodes.add_inode(1, 1));
}
}
1 change: 1 addition & 0 deletions src/interactive/app_test/utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ pub fn initialized_app_and_terminal_with_closure<P: AsRef<Path>>(
threads: 1,
byte_format: ByteFormat::Metric,
apparent_size: true,
count_links: false,
color: Color::None,
sorting: TraversalSorting::AlphabeticalByFileName,
},
Expand Down
2 changes: 2 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ extern crate jwalk;

mod aggregate;
mod common;
mod inodefilter;

pub mod traverse;

pub use aggregate::aggregate;
pub use common::*;
pub(crate) use inodefilter::InodeFilter;
1 change: 1 addition & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ fn run() -> Result<(), Error> {
Color::None
},
apparent_size: opt.apparent_size,
count_links: opt.count_links,
sorting: TraversalSorting::None,
};
let res = match opt.command {
Expand Down
4 changes: 4 additions & 0 deletions src/options.rs
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ pub struct Args {
#[structopt(short = "A", long = "apparent-size")]
pub apparent_size: bool,

/// Count hard-linked files each time they are seen
#[structopt(short = "l", long = "count-links")]
pub count_links: bool,

/// One or more input files or directories. If unset, we will use all entries in the current working directory.
#[structopt(parse(from_os_str))]
pub input: Vec<PathBuf>,
Expand Down
5 changes: 3 additions & 2 deletions src/traverse.rs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
use crate::{get_size_or_panic, WalkOptions};
use crate::{get_size_or_panic, InodeFilter, WalkOptions};
use failure::Error;
use petgraph::{graph::NodeIndex, stable_graph::StableGraph, Directed, Direction};
use std::{ffi::OsString, path::PathBuf, time::Duration, time::Instant};
Expand Down Expand Up @@ -66,6 +66,7 @@ impl Traversal {
let mut sizes_per_depth_level = Vec::new();
let mut current_size_at_depth = 0;
let mut previous_depth = 0;
let mut inodes = InodeFilter::default();

let mut last_checked = Instant::now();

Expand Down Expand Up @@ -93,7 +94,7 @@ impl Traversal {
entry.file_name
};
let file_size = match entry.metadata {
Some(Ok(ref m)) if !m.is_dir() => {
Some(Ok(ref m)) if !m.is_dir() && (walk_options.count_links || inodes.add(m)) => {
if walk_options.apparent_size {
m.len()
} else {
Expand Down