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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
use std::{backtrace::BacktraceStatus, fmt};
use crate::{Realloc, ReallocNull, Region, Request};
/// A single violation in the variants enforced by checkers.
#[derive(Debug, Clone)]
#[non_exhaustive]
pub enum Violation {
/// A region produced by the allocator `requested`, overlaps with at least
/// on `existing` allocation.
ConflictingAlloc {
/// The allocated region.
request: Request,
/// The existing region.
existing: Request,
},
/// A region produced by the allocator `requested` was not zeroed as
/// expected.
NonZeroedAlloc {
/// The allocated region.
alloc: Request,
},
/// A region reallocatoed by the allocator was not copied appropriately.
/// Meaning, the prefixing bytes between `free` and `alloc` do not match.
NonCopiedRealloc {
/// The reallocation.
realloc: Realloc,
},
/// Allocator was asked to reallocate a null pointer.
ReallocNull {
/// The null relocation.
realloc: ReallocNull,
},
/// A region produced by the allocator `requested` was not aligned
/// appropriately.
MisalignedAlloc {
/// The allocated region.
alloc: Request,
},
/// A freed region `requested` only freed part of at least one other region
/// `existing`.
IncompleteFree {
/// The freed region.
request: Request,
/// The existing region.
existing: Request,
},
/// A freed region `requested` provided the wrong alignment metadata.
/// See [std::alloc::Layout::align].
MisalignedFree {
/// The freed region.
request: Request,
/// The existing region.
existing: Request,
},
/// A freed region `requested` was not allocated at the time it was freed.
MissingFree {
/// The freed region.
request: Request,
},
/// A `region` was leaked. In that it was allocated but never freed.
Leaked {
/// The leaked region.
alloc: Request,
},
}
/// A single violation to the virtual memory model of checkers.
impl Violation {
/// Test that this violation refers to a dangling region and that it matches
/// the given predicate.
///
/// # Examples
///
/// ```rust
/// # use checkers::{Request, Region, Violation};
/// let alloc = Request::without_backtrace(Region::new(42.into(), 20, 4));
/// let violation = Violation::Leaked { alloc };
/// assert!(violation.is_leaked_with(|r| r.size == 20 && r.align == 4));
///
/// let alloc = Request::without_backtrace(Region::new(10.into(), 10, 1));
/// let violation = Violation::MisalignedAlloc { alloc };
/// assert!(!violation.is_leaked_with(|r| true));
/// ```
pub fn is_leaked_with<F>(&self, f: F) -> bool
where
F: FnOnce(Region) -> bool,
{
match self {
Self::Leaked { alloc } => f(alloc.region),
_ => false,
}
}
}
impl fmt::Display for Violation {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::ConflictingAlloc { request, existing } => {
write!(
f,
"Requested allocation ({}) overlaps with existing ({})",
request.region, existing.region
)?;
if request.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
write!(f, "Allocation Backtrace: {:?}", request.backtrace)?;
}
if existing.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
write!(f, "Existing Allocation Backtrace: {:?}", existing.backtrace)?;
}
Ok(())
}
Self::NonZeroedAlloc { alloc } => {
write!(
f,
"Requested allocation ({}) was not zerod by the allocator",
alloc.region
)?;
if alloc.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
write!(f, "Backtrace: {:?}", alloc.backtrace)?;
}
Ok(())
}
Self::NonCopiedRealloc { realloc } => {
write!(
f,
"Relocating from ({}) to ({}) did not correctly copy the prefixing bytes",
realloc.free, realloc.alloc,
)?;
if realloc.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
write!(f, "Reallocation Backtrace: {:?}", realloc.backtrace)?;
}
Ok(())
}
Self::ReallocNull { realloc } => {
write!(f, "Tried to reallocate null pointer")?;
if realloc.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
write!(f, "Reallocation Backtrace: {:?}", realloc.backtrace)?;
}
Ok(())
}
Self::MisalignedAlloc { alloc } => {
write!(f, "Allocated region ({}) is misaligned.", alloc.region)?;
if alloc.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
write!(f, "Backtrace: {:?}", alloc.backtrace)?;
}
Ok(())
}
Self::IncompleteFree { request, existing } => {
write!(
f,
"Freed ({}) only part of existing region ({})",
request.region, existing.region
)?;
if request.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
write!(f, "Requested Backtrace: {:?}", request.backtrace)?;
}
if request.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
write!(f, "Existing Backtrace: {:?}", request.backtrace)?;
}
Ok(())
}
Self::MisalignedFree { request, existing } => {
write!(
f,
"Freed region ({}) has different alignment from existing ({})",
request.region, existing.region
)?;
if request.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
write!(f, "Requested Backtrace: {:?}", request.backtrace)?;
}
if request.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
write!(f, "Existing Backtrace: {:?}", request.backtrace)?;
}
Ok(())
}
Self::MissingFree { request } => {
write!(f, "Freed missing region ({})", request.region)?;
if request.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
write!(f, "Backtrace: {:?}", request.backtrace)?;
}
Ok(())
}
Self::Leaked { alloc } => {
write!(f, "Dangling region ({})", alloc.region)?;
if alloc.backtrace.status() == BacktraceStatus::Captured {
writeln!(f)?;
write!(f, "Backtrace: {:?}", alloc.backtrace)?;
}
Ok(())
}
}
}
}