memscope-rs 0.2.0

A memory tracking library for Rust applications.
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

use crate::capture::types::ImplementationDifficulty;
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UnknownMemoryRegionAnalysis {
    pub total_unknown_bytes: usize,
    pub unknown_percentage: f64,
    pub unknown_categories: Vec<UnknownMemoryCategory>,
    pub potential_causes: Vec<UnknownMemoryCause>,
    pub reduction_strategies: Vec<UnknownRegionReductionStrategy>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UnknownMemoryCategory {
    pub category_type: UnknownRegionType,
    pub description: String,
    pub estimated_size: usize,
    pub confidence_level: f64,
    pub examples: Vec<UnknownMemoryExample>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum UnknownRegionType {
    MemoryMappedRegions,
    ThreadLocalStorage,
    DynamicLibraryRegions,
    SystemReservedRegions,
    JitCodeRegions,
    ExternalLibraryAllocations,
    GuardPages,
    VdsoRegions,
    AnonymousMappings,
    SharedMemorySegments,
    PreTrackingAllocations,
    CorruptedMetadata,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UnknownMemoryExample {
    pub address_range: (usize, usize),
    pub size: usize,
    pub suspected_origin: String,
    pub access_pattern: MemoryAccessPattern,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum UnknownMemoryCause {
    ForeignFunctionInterface {
        library_name: String,
        function_name: Option<String>,
    },
    MemoryMapping {
        mapping_type: MappingType,
        file_path: Option<String>,
    },
    SystemAllocations {
        allocation_type: SystemAllocationType,
    },
    ThreadingMemory {
        thread_id: Option<u64>,
        memory_type: ThreadMemoryType,
    },
    DynamicLoading {
        library_path: String,
        load_time: u64,
    },
    InstrumentationGaps {
        gap_type: InstrumentationGapType,
        description: String,
    },
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum MappingType {
    FileMapping,
    AnonymousMapping,
    SharedMapping,
    DeviceMapping,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum SystemAllocationType {
    KernelBuffers,
    DriverMemory,
    SystemCaches,
    HardwareReserved,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ThreadMemoryType {
    ThreadStack,
    ThreadLocalStorage,
    ThreadControlBlock,
    ThreadSynchronization,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum InstrumentationGapType {
    EarlyBootstrap,
    SignalHandlers,
    InterruptHandlers,
    AtomicOperations,
    CompilerOptimizations,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UnknownRegionReductionStrategy {
    pub strategy_type: ReductionStrategyType,
    pub description: String,
    pub implementation_steps: Vec<String>,
    pub expected_improvement: f64,
    pub implementation_difficulty: ImplementationDifficulty,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum ReductionStrategyType {
    EnhancedInstrumentation,
    BetterSymbolResolution,
    MemoryMappingTracking,
    FfiCallInterception,
    SystemCallMonitoring,
    ThreadAwareTracking,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SystemRegionInfo {
    pub region_type: String,
    pub description: String,
    pub read_only: bool,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct LibraryMappingInfo {
    pub start_address: usize,
    pub end_address: usize,
    pub permissions: String,
    pub file_path: String,
}

impl LibraryMappingInfo {
    pub fn contains_address(&self, addr: usize) -> bool {
        addr >= self.start_address && addr < self.end_address
    }
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum MemoryAccessPattern {
    Sequential,
    Random,
    Sparse,
    Unknown,
}