vmdk-core 0.6.4

Pure-Rust read-only VMware VMDK disk image reader (monolithicSparse, streamOptimized, twoGbMaxExtentFlat/Sparse, monolithicFlat)
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

//! Internal diagnostics — a single, greppable home for every trace event.
//!
//! Default-off and zero-cost: without the `trace` feature these are `#[inline]`
//! no-ops and the crate carries no logging dependency. Enable `trace` to forward
//! every event to the [`tracing`](https://docs.rs/tracing) ecosystem for
//! structured, level-filtered debugging of reads over untrusted images.
//!
//! Keeping all diagnostics here (rather than scattered macros) means the full set
//! of observable events is discoverable at a glance, and the read/recovery code
//! reads as plain control flow.

/// An image was opened: detected format and geometry.
#[cfg(feature = "trace")]
pub(crate) fn opened(
    format: &str,
    version: u32,
    virtual_size: u64,
    grain_size: u64,
    compressed: bool,
) {
    tracing::debug!(
        format,
        version,
        virtual_size,
        grain_size,
        compressed,
        "vmdk opened"
    );
}
#[cfg(not(feature = "trace"))]
#[inline]
pub(crate) fn opened(
    _format: &str,
    _version: u32,
    _virtual_size: u64,
    _grain_size: u64,
    _compressed: bool,
) {
}

/// A virtual offset was resolved to a physical location (`kind`: sparse / file / compressed).
#[cfg(feature = "trace")]
pub(crate) fn grain_resolved(virtual_offset: u64, kind: &'static str) {
    tracing::trace!(virtual_offset, kind, "grain resolved");
}
#[cfg(not(feature = "trace"))]
#[inline]
pub(crate) fn grain_resolved(_virtual_offset: u64, _kind: &'static str) {}

/// A damaged primary grain-table pointer was recovered via the redundant grain directory.
#[cfg(feature = "trace")]
pub(crate) fn pointer_recovered(gd_idx: usize, primary: u32, via_rgd: u32) {
    tracing::debug!(
        gd_idx,
        primary,
        via_rgd,
        "grain-table pointer recovered via RGD"
    );
}
#[cfg(not(feature = "trace"))]
#[inline]
pub(crate) fn pointer_recovered(_gd_idx: usize, _primary: u32, _via_rgd: u32) {}

/// A lost primary grain-table entry was recovered from the redundant grain table.
#[cfg(feature = "trace")]
pub(crate) fn entry_recovered(gd_idx: usize, gte_idx: u64) {
    tracing::debug!(gd_idx, gte_idx, "grain-table entry recovered via RGD");
}
#[cfg(not(feature = "trace"))]
#[inline]
pub(crate) fn entry_recovered(_gd_idx: usize, _gte_idx: u64) {}

/// A snapshot/delta chain layer was opened.
#[cfg(feature = "trace")]
pub(crate) fn chain_layer(depth: usize, cid: u32, parent_cid: u32) {
    tracing::debug!(depth, cid, parent_cid, "chain layer opened");
}
#[cfg(not(feature = "trace"))]
#[inline]
pub(crate) fn chain_layer(_depth: usize, _cid: u32, _parent_cid: u32) {}