pcf-debug 0.0.4

Inspection and visualisation tool for Partitioned Container Format (PCF) files
Documentation 
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

//! Tests that the model surfaces structural anomalies as diagnostics instead of
//! panicking. Files are hand-built from the crate's public serialisers so the
//! anomalies are exact.

mod common;

use pcf::{encode_label, FileHeader, HashAlgo, PartitionEntry, TableBlockHeader};
use pcf_debug::build_report;
use pcf_debug::model::diag::DiagKind;
use pcf_debug::plugin::DecoderRegistry;

fn entry(uid: u8, start: u64, used: u64, max: u64) -> PartitionEntry {
    PartitionEntry {
        partition_type: 1,
        uid: [uid; 16],
        label: encode_label("p").unwrap(),
        start_offset: start,
        max_length: max,
        used_bytes: used,
        data_hash_algo: HashAlgo::None,
        data_hash: [0u8; 64],
    }
}

/// Build a file by hand: a 20-byte header, one `None`-hashed block at offset 20,
/// then `entries`, then `data_len` bytes of payload.
fn handmade(entries: &[PartitionEntry], data_len: usize) -> Vec<u8> {
    let header = FileHeader {
        version_major: 1,
        version_minor: 0,
        partition_table_offset: 20,
    };
    let block = TableBlockHeader {
        partition_count: entries.len() as u8,
        next_table_offset: 0,
        table_hash_algo: HashAlgo::None,
        table_hash: [0u8; 64],
    };
    let mut img = Vec::new();
    img.extend_from_slice(&header.to_bytes());
    img.extend_from_slice(&block.to_bytes());
    for e in entries {
        img.extend_from_slice(&e.to_bytes());
    }
    img.resize(img.len() + data_len, 0);
    img
}

#[test]
fn trailing_dead_space_is_reported_as_a_gap() {
    let mut data = common::canonical();
    data.extend_from_slice(&[0u8; 32]); // 32 bytes of trailing padding
    let report = build_report(&data, true, &DecoderRegistry::with_builtins());
    let gap = report
        .layout
        .diagnostics
        .iter()
        .find(|d| matches!(d.kind, DiagKind::Gap { .. }));
    assert!(gap.is_some(), "trailing padding should be a gap diagnostic");
}

#[test]
fn overlapping_data_regions_are_detected() {
    // Two entries' data regions intersect: [data..+10) and [data+4..+14).
    let data_base = 20 + 74 + 2 * 141; // header + block header + two entries
    let entries = [
        entry(1, data_base as u64, 10, 10),
        entry(2, data_base as u64 + 4, 10, 10),
    ];
    let img = handmade(&entries, 14);
    let report = build_report(&img, true, &DecoderRegistry::with_builtins());
    let overlap = report
        .layout
        .diagnostics
        .iter()
        .find(|d| matches!(d.kind, DiagKind::Overlap { .. }));
    assert!(
        overlap.is_some(),
        "intersecting data regions should be flagged"
    );
}

#[test]
fn data_past_eof_is_truncated_not_a_panic() {
    let data_base = 20 + 74 + 141;
    // used_bytes claims 100 bytes but only 5 exist after the entry.
    let entries = [entry(1, data_base as u64, 100, 100)];
    let img = handmade(&entries, 5);
    let report = build_report(&img, true, &DecoderRegistry::with_builtins());
    let trunc = report
        .layout
        .diagnostics
        .iter()
        .find(|d| matches!(d.kind, DiagKind::Truncated { .. }));
    assert!(
        trunc.is_some(),
        "out-of-bounds data must be a Truncated diagnostic"
    );
}

#[test]
fn short_file_does_not_panic() {
    let report = build_report(&[0u8; 4], true, &DecoderRegistry::with_builtins());
    assert!(report
        .layout
        .diagnostics
        .iter()
        .any(|d| matches!(d.kind, DiagKind::BadHeader { .. })));
}