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
227
228
229
230
|
use hash_map::HashMap;
use std::borrow::Borrow;
use std::hash::{BuildHasher, Hash};
use std::ptr;
use FailedAllocationError;
#[cfg(target_pointer_width = "32")]
const CANARY: usize = 0x42cafe99;
#[cfg(target_pointer_width = "64")]
const CANARY: usize = 0x42cafe9942cafe99;
#[cfg(target_pointer_width = "32")]
const POISON: usize = 0xdeadbeef;
#[cfg(target_pointer_width = "64")]
const POISON: usize = 0xdeadbeefdeadbeef;
#[derive(Clone, Debug)]
enum JournalEntry {
Insert(usize),
GOIW(usize),
Remove(usize),
DidClear(usize),
}
#[derive(Clone, Debug)]
pub struct DiagnosticHashMap<K, V, S>
where K: Eq + Hash,
S: BuildHasher
{
map: HashMap<K, (usize, V), S>,
journal: Vec<JournalEntry>,
readonly: bool,
}
impl<K: Hash + Eq, V, S: BuildHasher> DiagnosticHashMap<K, V, S>
where K: Eq + Hash,
S: BuildHasher
{
#[inline(always)]
pub fn inner(&self) -> &HashMap<K, (usize, V), S> {
&self.map
}
#[inline(never)]
pub fn begin_mutation(&mut self) {
self.map.verify();
assert!(self.readonly);
self.readonly = false;
self.verify();
}
#[inline(never)]
pub fn end_mutation(&mut self) {
self.map.verify();
assert!(!self.readonly);
self.readonly = true;
self.verify();
}
fn verify(&self) {
let mut position = 0;
let mut bad_canary: Option<(usize, *const usize)> = None;
for (_,v) in self.map.iter() {
let canary_ref = &v.0;
if *canary_ref == CANARY {
position += 1;
continue;
}
bad_canary = Some((*canary_ref, canary_ref));
}
if let Some(c) = bad_canary {
self.report_corruption(c.0, c.1, position);
}
}
#[inline(always)]
pub fn with_hasher(hash_builder: S) -> Self {
Self {
map: HashMap::<K, (usize, V), S>::with_hasher(hash_builder),
journal: Vec::new(),
readonly: true,
}
}
#[inline(always)]
pub fn len(&self) -> usize {
self.map.len()
}
#[inline(always)]
pub fn is_empty(&self) -> bool {
self.map.is_empty()
}
#[inline(always)]
pub fn contains_key<Q: ?Sized>(&self, k: &Q) -> bool
where K: Borrow<Q>,
Q: Hash + Eq
{
self.map.contains_key(k)
}
#[inline(always)]
pub fn get<Q: ?Sized>(&self, k: &Q) -> Option<&V>
where K: Borrow<Q>,
Q: Hash + Eq
{
self.map.get(k).map(|v| &v.1)
}
#[inline(always)]
pub fn try_get_or_insert_with<F: FnOnce() -> V>(
&mut self,
key: K,
default: F
) -> Result<&mut V, FailedAllocationError> {
assert!(!self.readonly);
self.journal.push(JournalEntry::GOIW(self.map.make_hash(&key).inspect()));
let entry = self.map.try_entry(key)?;
Ok(&mut entry.or_insert_with(|| (CANARY, default())).1)
}
#[inline(always)]
pub fn try_insert(&mut self, k: K, v: V) -> Result<Option<V>, FailedAllocationError> {
assert!(!self.readonly);
self.journal.push(JournalEntry::Insert(self.map.make_hash(&k).inspect()));
let old = self.map.try_insert(k, (CANARY, v))?;
Ok(old.map(|x| x.1))
}
#[inline(always)]
pub fn remove<Q: ?Sized>(&mut self, k: &Q) -> Option<V>
where K: Borrow<Q>,
Q: Hash + Eq
{
assert!(!self.readonly);
self.journal.push(JournalEntry::Remove(self.map.make_hash(k).inspect()));
if let Some(v) = self.map.get_mut(k) {
unsafe { ptr::write_volatile(&mut v.0, POISON); }
}
self.map.remove(k).map(|x| x.1)
}
#[inline(always)]
pub fn clear(&mut self) where K: 'static, V: 'static {
// We handle scoped mutations for the caller here, since callsites that
// invoke clear() don't benefit from the coalescing we do around insertion.
self.begin_mutation();
self.journal.clear();
self.journal.push(JournalEntry::DidClear(self.map.raw_capacity()));
self.map.clear();
self.end_mutation();
}
#[inline(never)]
fn report_corruption(
&self,
canary: usize,
canary_addr: *const usize,
position: usize
) {
use ::std::ffi::CString;
let key = b"HashMapJournal\0";
let value = CString::new(format!("{:?}", self.journal)).unwrap();
unsafe {
Gecko_AnnotateCrashReport(
key.as_ptr() as *const ::std::os::raw::c_char,
value.as_ptr(),
);
}
panic!(
"HashMap Corruption (sz={}, cap={}, pairsz={}, cnry={:#x}, pos={}, base_addr={:?}, cnry_addr={:?}, jrnl_len={})",
self.map.len(),
self.map.raw_capacity(),
::std::mem::size_of::<(K, (usize, V))>(),
canary,
position,
self.map.raw_buffer(),
canary_addr,
self.journal.len(),
);
}
}
impl<K, V, S> PartialEq for DiagnosticHashMap<K, V, S>
where K: Eq + Hash,
V: PartialEq,
S: BuildHasher
{
fn eq(&self, other: &Self) -> bool {
self.map.eq(&other.map)
}
}
impl<K, V, S> Eq for DiagnosticHashMap<K, V, S>
where K: Eq + Hash,
V: Eq,
S: BuildHasher
{
}
impl<K, V, S> Default for DiagnosticHashMap<K, V, S>
where K: Eq + Hash,
S: BuildHasher + Default
{
fn default() -> Self {
Self {
map: HashMap::default(),
journal: Vec::new(),
readonly: true,
}
}
}
impl<K: Hash + Eq, V, S: BuildHasher> Drop for DiagnosticHashMap<K, V, S>
where K: Eq + Hash,
S: BuildHasher
{
fn drop(&mut self) {
self.map.verify();
debug_assert!(self.readonly, "Dropped while mutating");
self.verify();
}
}
extern "C" {
pub fn Gecko_AnnotateCrashReport(key_str: *const ::std::os::raw::c_char,
value_str: *const ::std::os::raw::c_char);
}
|
