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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
use std::fmt;
use symbolic_common::{Arch, AsSelf, DebugId, Language, Name, NameMangling};
use crate::{new, old, preamble, SymCacheError};
pub(crate) const SYMCACHE_VERSION_CUTOFF: u32 = 6;
impl From<new::Error> for SymCacheError {
fn from(new_error: new::Error) -> Self {
let kind = match new_error {
new::Error::BufferNotAligned
| new::Error::BadFormatLength
| new::Error::WrongEndianness => old::SymCacheErrorKind::BadCacheFile,
new::Error::HeaderTooSmall => old::SymCacheErrorKind::BadFileHeader,
new::Error::WrongFormat => old::SymCacheErrorKind::BadFileMagic,
new::Error::WrongVersion => old::SymCacheErrorKind::UnsupportedVersion,
};
Self::from(kind)
}
}
#[derive(Debug)]
enum SymCacheInner<'data> {
Old(old::SymCache<'data>),
New(new::SymCache<'data>),
}
pub struct SymCache<'data>(SymCacheInner<'data>);
impl<'data> SymCache<'data> {
pub fn parse(data: &'data [u8]) -> Result<Self, SymCacheError> {
let preamble = preamble::Preamble::parse(data)?;
if preamble.version > SYMCACHE_VERSION_CUTOFF {
Ok(Self(SymCacheInner::New(new::SymCache::parse(data)?)))
} else {
Ok(Self(SymCacheInner::Old(old::SymCache::parse(data)?)))
}
}
pub fn version(&self) -> u32 {
match &self.0 {
SymCacheInner::New(symc) => symc.version(),
SymCacheInner::Old(symc) => symc.version(),
}
}
pub fn is_latest(&self) -> bool {
self.version() == crate::SYMCACHE_VERSION
}
pub fn arch(&self) -> Arch {
match &self.0 {
SymCacheInner::New(symc) => symc.arch(),
SymCacheInner::Old(symc) => symc.arch(),
}
}
pub fn debug_id(&self) -> DebugId {
match &self.0 {
SymCacheInner::New(symc) => symc.debug_id(),
SymCacheInner::Old(symc) => symc.debug_id(),
}
}
#[deprecated(since = "8.6.0", note = "this will be removed in a future version")]
pub fn has_line_info(&self) -> bool {
match &self.0 {
#[allow(deprecated)]
SymCacheInner::New(symc) => symc.has_line_info(),
SymCacheInner::Old(symc) => symc.has_line_info(),
}
}
#[deprecated(since = "8.6.0", note = "this will be removed in a future version")]
pub fn has_file_info(&self) -> bool {
match &self.0 {
#[allow(deprecated)]
SymCacheInner::New(symc) => symc.has_file_info(),
SymCacheInner::Old(symc) => symc.has_file_info(),
}
}
#[deprecated(since = "8.6.0", note = "this will be removed in a future version")]
#[allow(deprecated)]
pub fn functions(&self) -> Functions<'data> {
match &self.0 {
#[allow(deprecated)]
SymCacheInner::New(symc) => {
Functions(FunctionsInner::New(symc.functions().enumerate()))
}
SymCacheInner::Old(symc) => Functions(FunctionsInner::Old(symc.functions())),
}
}
pub fn lookup(&self, addr: u64) -> Result<Lookup<'data, '_>, SymCacheError> {
match &self.0 {
SymCacheInner::New(symc) => Ok(Lookup(LookupInner::New {
iter: symc.lookup(addr),
lookup_addr: addr,
})),
SymCacheInner::Old(symc) => {
let lookup = symc.lookup(addr)?;
Ok(Lookup(LookupInner::Old(lookup)))
}
}
}
}
impl<'data> fmt::Debug for SymCache<'data> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match &self.0 {
SymCacheInner::Old(symcache) => symcache.fmt(f),
SymCacheInner::New(symcache) => symcache.fmt(f),
}
}
}
impl<'slf, 'd: 'slf> AsSelf<'slf> for SymCache<'d> {
type Ref = SymCache<'slf>;
fn as_self(&'slf self) -> &Self::Ref {
self
}
}
#[derive(Clone, Debug)]
enum FunctionInner<'data> {
Old(old::Function<'data>),
New((usize, new::Function<'data>)),
}
#[derive(Clone)]
#[deprecated(since = "8.6.0", note = "this will be removed in a future version")]
pub struct Function<'data>(FunctionInner<'data>);
#[allow(deprecated)]
impl<'data> Function<'data> {
pub fn id(&self) -> usize {
match &self.0 {
FunctionInner::Old(function) => function.id(),
FunctionInner::New((i, _)) => *i,
}
}
pub fn parent_id(&self) -> Option<usize> {
match &self.0 {
FunctionInner::Old(function) => function.parent_id(),
FunctionInner::New(_) => None,
}
}
pub fn address(&self) -> u64 {
match &self.0 {
FunctionInner::Old(function) => function.address(),
FunctionInner::New((_, function)) => function.entry_pc() as u64,
}
}
pub fn symbol(&self) -> &'data str {
match &self.0 {
FunctionInner::Old(function) => function.symbol(),
FunctionInner::New((_, function)) => function.name().unwrap_or("?"),
}
}
pub fn language(&self) -> Language {
match &self.0 {
FunctionInner::Old(function) => function.language(),
FunctionInner::New((_, function)) => function.language(),
}
}
pub fn name(&self) -> Name<'_> {
match &self.0 {
FunctionInner::Old(function) => function.name(),
FunctionInner::New((_, function)) => Name::new(
function.name().unwrap_or("?"),
NameMangling::Unknown,
function.language(),
),
}
}
pub fn compilation_dir(&self) -> &str {
match &self.0 {
FunctionInner::Old(function) => function.compilation_dir(),
FunctionInner::New((_, function)) => function.comp_dir().unwrap_or_default(),
}
}
pub fn lines(&self) -> Lines<'data> {
match &self.0 {
FunctionInner::Old(function) => Lines(LinesInner::Old(function.lines())),
FunctionInner::New(_) => Lines(LinesInner::New),
}
}
}
#[allow(deprecated)]
impl<'data> fmt::Debug for Function<'data> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match &self.0 {
FunctionInner::Old(function) => function.fmt(f),
FunctionInner::New(function) => function.fmt(f),
}
}
}
#[derive(Clone, Debug)]
enum FunctionsInner<'data> {
Old(old::Functions<'data>),
New(std::iter::Enumerate<new::Functions<'data>>),
}
#[derive(Clone)]
#[deprecated(since = "8.6.0", note = "this will be removed in a future version")]
pub struct Functions<'data>(FunctionsInner<'data>);
#[allow(deprecated)]
impl<'data> Iterator for Functions<'data> {
type Item = Result<Function<'data>, SymCacheError>;
fn next(&mut self) -> Option<Self::Item> {
match &mut self.0 {
FunctionsInner::Old(functions) => {
let function_old = functions.next()?;
Some(function_old.map(|f| Function(FunctionInner::Old(f))))
}
FunctionsInner::New(functions) => {
let function_new = functions.next()?;
Some(Ok(Function(FunctionInner::New(function_new))))
}
}
}
}
#[allow(deprecated)]
impl<'data> fmt::Debug for Functions<'data> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match &self.0 {
FunctionsInner::Old(functions) => functions.fmt(f),
FunctionsInner::New(functions) => functions.fmt(f),
}
}
}
#[derive(Clone, Debug)]
enum LookupInner<'data, 'cache> {
Old(old::Lookup<'data, 'cache>),
New {
iter: new::SourceLocationIter<'data, 'cache>,
lookup_addr: u64,
},
}
#[derive(Clone)]
pub struct Lookup<'data, 'cache>(LookupInner<'data, 'cache>);
impl<'data, 'cache> Lookup<'data, 'cache> {
pub fn collect<B>(self) -> Result<B, SymCacheError>
where
B: std::iter::FromIterator<old::LineInfo<'data>>,
{
Iterator::collect(self)
}
}
impl<'data, 'cache> Iterator for Lookup<'data, 'cache> {
type Item = Result<old::LineInfo<'data>, old::SymCacheError>;
fn next(&mut self) -> Option<Self::Item> {
match &mut self.0 {
LookupInner::Old(lookup) => lookup.next(),
LookupInner::New { iter, lookup_addr } => {
let sl = iter.next()?;
Some(Ok(old::LineInfo {
arch: sl.cache.arch(),
debug_id: sl.cache.debug_id(),
sym_addr: sl
.function()
.map(|f| f.entry_pc() as u64)
.unwrap_or(u64::MAX),
line_addr: *lookup_addr,
instr_addr: *lookup_addr,
line: sl.line(),
lang: sl.function().map(|f| f.language()).unwrap_or_default(),
symbol: sl.function().and_then(|f| f.name()),
filename: sl.file().map(|f| f.path_name()).unwrap_or_default(),
base_dir: sl.file().and_then(|f| f.directory()).unwrap_or_default(),
comp_dir: sl.file().and_then(|f| f.comp_dir()).unwrap_or_default(),
}))
}
}
}
}
impl<'data, 'cache> fmt::Debug for Lookup<'data, 'cache> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match &self.0 {
LookupInner::Old(lookup) => lookup.fmt(f),
LookupInner::New { iter, .. } => iter.fmt(f),
}
}
}
#[derive(Clone)]
enum LinesInner<'data> {
Old(old::Lines<'data>),
New,
}
#[derive(Clone)]
pub struct Lines<'data>(LinesInner<'data>);
impl<'a> Iterator for Lines<'a> {
type Item = Result<old::Line<'a>, SymCacheError>;
fn next(&mut self) -> Option<Self::Item> {
match self.0 {
LinesInner::Old(ref mut lines) => lines.next(),
LinesInner::New => None,
}
}
}