teamy-mft 0.7.1

TeamDman's Master File Table CLI and library for NTFS.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

use crate::mft::fast_entry;
use crate::mft::mft_file::MftFile;
use crate::mft::path_resolve;
use crate::mft::path_resolve::MftEntryPathCollection;
use eyre::Result;
use humansize::BINARY;
use std::path::PathBuf;
use std::time::Instant;
use teamy_uom_extensions::HumanInformationExt;
use teamy_uom_extensions::HumanInformationRateExt;
use teamy_uom_extensions::HumanTimeExt;
use teamy_uom_extensions::InformationOverExt;
use thousands::Separable;
use tracing::debug;
use tracing::debug_span;
use tracing::info_span;
use tracing::instrument;
use tracing::trace;
use uom::si::f64::Ratio;
use uom::si::f64::Time;
use uom::si::frequency::hertz;
use uom::si::information::byte;
use uom::si::ratio::ratio;
use uom::si::time::second;

/// Overall high-level processing of an MFT file: mmap -> copy -> fixups -> extract names -> resolve paths.
/// Resolved paths include the drive prefix (e.g., `C:\`) so callers can inject or display them directly.
///
/// # Errors
///
/// Returns an error if reading or parsing the cached MFT data fails.
#[instrument(level = "debug")]
pub fn convert_mft_file_to_path_collection(
    drive_letter: &str,
    mft_file: &MftFile,
) -> Result<MftEntryPathCollection> {
    let _span = info_span!(
        "convert_mft_file_to_path_collection",
        drive_letter = %drive_letter,
        mft_size = %mft_file.size().format_human(BINARY),
        mft_entries = %mft_file.record_count().separate_with_commas(),
    )
    .entered();
    let start = std::time::Instant::now();

    // collect filename attributes (parallel)
    let scan_start = Instant::now();
    let file_names = {
        let _span = debug_span!(
            "collect_filenames",
            drive_letter = %drive_letter,
            mft_size = mft_file.size().format_human(BINARY),
            mft_entries = mft_file.record_count().separate_with_commas(),
        )
        .entered();
        fast_entry::collect_filenames(mft_file)
    };
    let scan_elapsed = Time::new::<second>(scan_start.elapsed().as_secs_f64());
    let scan_rate = mft_file.size().over(scan_elapsed);
    trace!(
        drive_letter = &drive_letter,
        "Took {} ({}) entries_with_names={}",
        scan_elapsed.format_human(),
        scan_rate.format_human(BINARY),
        file_names.entry_count().separate_with_commas()
    );

    // resolve paths (multi-parent default)
    trace!(
        drive_letter = &drive_letter,
        "Resolving (multi-parent) paths for {} filename attributes",
        file_names.x30_count().separate_with_commas()
    );
    let path_resolve_start = Instant::now();
    let drive_prefix = PathBuf::from(format!("{drive_letter}:\\"));
    let multi = path_resolve::resolve_paths_all_parallel(&file_names, &drive_prefix)?;
    let path_resolve_elapsed = Time::new::<second>(path_resolve_start.elapsed().as_secs_f64());
    let total_paths = multi.total_paths();
    let resolved_entries = multi.0.iter().filter(|v| !v.is_empty()).count();
    #[allow(
        clippy::cast_precision_loss,
        reason = "counts may exceed 2^52 but we only use them for rate reporting"
    )]
    let resolved_entries_f64 = resolved_entries as f64;
    let resolved_size = uom::si::f64::Information::new::<byte>(resolved_entries_f64 * 256.0);
    let resolve_rate = resolved_size.over(path_resolve_elapsed);
    trace!(
        drive_letter = &drive_letter,
        "Took {} ({}) entries_resolved={} total_paths={}",
        path_resolve_elapsed.format_human(),
        resolve_rate.format_human(BINARY),
        resolved_entries.separate_with_commas(),
        total_paths.separate_with_commas()
    );

    trace!(
        drive_letter = &drive_letter,
        "MFT size={} entries={} entry_size={} names={} resolved={} timings(scan/resolve)={}/{}",
        mft_file.size().format_human(BINARY),
        mft_file.record_count().separate_with_commas(),
        mft_file.record_size().format_human(BINARY),
        file_names.x30_count().separate_with_commas(),
        resolved_entries.separate_with_commas(),
        scan_elapsed.format_human(),
        path_resolve_elapsed.format_human()
    );

    let elapsed = Time::new::<second>(start.elapsed().as_secs_f64());
    // aggregate performance statistics
    #[allow(
        clippy::cast_precision_loss,
        reason = "double precision rate math is best-effort for large MFT sizes"
    )]
    let total_size = uom::si::f64::Information::new::<byte>(mft_file.size().get::<byte>() as f64);
    let total_data_rate = total_size.over(elapsed); // overall throughput
    #[allow(
        clippy::cast_precision_loss,
        reason = "double precision entry rate math is best-effort for high entry counts"
    )]
    let entries_rate = Ratio::new::<ratio>(mft_file.record_count() as f64) / elapsed;
    debug!(
        drive_letter = &drive_letter,
        "Total processing time for {drive_letter} with {} entries: {} (size={} rate={} entries/s={})",
        mft_file.record_count().separate_with_commas(),
        elapsed.format_human(),
        mft_file.size().format_human(BINARY),
        total_data_rate.format_human(BINARY),
        entries_rate.get::<hertz>().trunc().separate_with_commas()
    );
    Ok(multi)
}