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
use std::io;
use std::path::{PathBuf, Path};
use std::fs::File;
use std::collections::HashMap;
use object::{Object, File as OFile};
use memmap::MmapOptions;
use gimli::*;
use rustc_demangle::demangle;
use cargo::core::Workspace;
use config::Config;
use source_analysis::*;
use traces::*;
type FuncDesc = (u64, u64, FunctionType);
#[derive(Clone, Copy, PartialEq)]
enum FunctionType {
Generated,
Test,
Standard
}
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
pub enum LineType {
TestMain,
TestEntry(u64),
FunctionEntry(u64),
Statement,
Condition,
Unknown,
UnusedGeneric,
}
#[derive(Clone, PartialEq, Eq, Hash)]
struct SourceLocation {
pub path: PathBuf,
pub line: u64,
}
#[derive(Debug, Clone)]
pub struct TracerData {
pub trace_type: LineType,
pub address: Option<u64>,
pub length: u64,
}
fn generate_func_desc<R, Offset>(die: &DebuggingInformationEntry<R, Offset>,
debug_str: &DebugStr<R>) -> Result<FuncDesc>
where R: Reader<Offset = Offset>,
Offset: ReaderOffset
{
let mut func_type = FunctionType::Standard;
let low = die.attr_value(DW_AT_low_pc)?;
let high = die.attr_value(DW_AT_high_pc)?;
let linkage = die.attr_value(DW_AT_linkage_name)?;
let low = match low {
Some(AttributeValue::Addr(x)) => x,
_ => 0u64,
};
let high = match high {
Some(AttributeValue::Udata(x)) => x,
_ => 0u64,
};
if let Some(AttributeValue::DebugStrRef(offset)) = linkage {
let name = debug_str.get_str(offset)
.and_then(|r| r.to_string().map(|s| s.to_string()))
.unwrap_or("".into());
let name = demangle(name.as_ref()).to_string();
func_type = if name.contains("tests::") {
FunctionType::Test
} else if name.contains("__test::main") {
FunctionType::Generated
} else {
FunctionType::Standard
};
}
Ok((low, high, func_type))
}
fn get_entry_points<R, Offset>(debug_info: &CompilationUnitHeader<R, Offset>,
debug_abbrev: &Abbreviations,
debug_str: &DebugStr<R>) -> Vec<FuncDesc>
where R: Reader<Offset = Offset>,
Offset: ReaderOffset
{
let mut result:Vec<FuncDesc> = Vec::new();
let mut cursor = debug_info.entries(debug_abbrev);
let _ = cursor.next_entry();
while let Ok(Some((_, node))) = cursor.next_dfs() {
if node.tag() == DW_TAG_subprogram {
if let Ok(fd) = generate_func_desc(node, debug_str) {
result.push(fd);
}
}
}
result
}
fn get_addresses_from_program<R, Offset>(prog: IncompleteLineNumberProgram<R>,
entries: &[(u64, LineType)],
project: &Path,
result: &mut HashMap<SourceLocation, Vec<TracerData>>) -> Result<()>
where R: Reader<Offset = Offset>,
Offset: ReaderOffset
{
let ( cprog, seq) = prog.sequences()?;
for s in seq {
let mut temp_map: HashMap<SourceLocation, TracerData> = HashMap::new();
let mut sm = cprog.resume_from(&s);
while let Ok(Some((header, &ln_row))) = sm.next_row() {
if !ln_row.is_stmt() || ln_row.line().is_none() {
continue;
}
if let Some(file) = ln_row.file(header) {
let mut path = PathBuf::new();
if let Some(dir) = file.directory(header) {
if let Ok(temp) = dir.to_string() {
path.push(temp.as_ref());
}
}
if let Ok(p) = path.canonicalize() {
path = p;
}
let is_target = if path.is_relative() {
path.starts_with("target")
} else {
path.starts_with(project.join("target"))
};
if !is_target && path.starts_with(project) {
if let Some(file) = ln_row.file(header) {
let line = ln_row.line().unwrap();
let file = file.path_name();
if let Ok(file) = file.to_string() {
path.push(file.as_ref());
if !path.is_file() {
continue;
}
let address = ln_row.address();
let desc = entries.iter()
.filter(|&&(addr, _)| addr == address )
.map(|&(_, t)| t)
.nth(0)
.unwrap_or(LineType::Unknown);
let loc = SourceLocation {
path: path,
line: line,
};
if desc != LineType::TestMain && !temp_map.contains_key(&loc) {
temp_map.insert(loc, TracerData {
address: Some(address),
trace_type: desc,
length: 1,
});
}
}
}
}
}
}
for (k, v) in &temp_map {
if result.contains_key(k) {
let mut x = result.get_mut(k).unwrap();
x.push(v.clone());
} else {
result.insert(k.clone(), vec![v.clone()]);
}
}
}
Ok(())
}
fn get_line_addresses(endian: RunTimeEndian,
project: &Path,
obj: &OFile,
analysis: &HashMap<PathBuf, LineAnalysis>,
config: &Config) -> Result<TraceMap> {
let mut result = TraceMap::new();
let debug_info = obj.section_data_by_name(".debug_info").unwrap_or_default();
let debug_info = DebugInfo::new(&debug_info, endian);
let debug_abbrev = obj.section_data_by_name(".debug_abbrev").unwrap_or_default();
let debug_abbrev = DebugAbbrev::new(&debug_abbrev, endian);
let debug_strings = obj.section_data_by_name(".debug_str").unwrap_or_default();
let debug_strings = DebugStr::new(&debug_strings, endian);
let debug_line = obj.section_data_by_name(".debug_line").unwrap_or_default();
let debug_line = DebugLine::new(&debug_line, endian);
let mut iter = debug_info.units();
while let Ok(Some(cu)) = iter.next() {
let addr_size = cu.address_size();
let abbr = match cu.abbreviations(&debug_abbrev) {
Ok(a) => a,
_ => continue,
};
let entries = get_entry_points(&cu, &abbr, &debug_strings)
.iter()
.map(|&(a, b, c)| {
match c {
FunctionType::Test => (a, LineType::TestEntry(b)),
FunctionType::Standard => (a, LineType::FunctionEntry(b)),
FunctionType::Generated => (a, LineType::TestMain),
}
}).collect::<Vec<_>>();
if let Ok(Some((_, root))) = cu.entries(&abbr).next_dfs() {
let offset = match root.attr_value(DW_AT_stmt_list) {
Ok(Some(AttributeValue::DebugLineRef(o))) => o,
_ => continue,
};
let prog = debug_line.program(offset, addr_size, None, None)?;
let mut temp_map : HashMap<SourceLocation, Vec<TracerData>> = HashMap::new();
if let Err(e) = get_addresses_from_program(prog, &entries, project, &mut temp_map) {
if config.verbose {
println!("Potential issue reading test addresses {}", e);
}
}
else {
for (_, v) in temp_map.iter_mut() {
v.dedup_by_key(|x| x.address);
}
let temp_map = temp_map.into_iter()
.filter(|&(ref k, _)| !(config.ignore_tests && k.path.starts_with(project.join("tests"))))
.filter(|&(ref k, _)| !(config.exclude_path(&k.path)))
.filter(|&(ref k, _)| !analysis.should_ignore(k.path.as_ref(), &(k.line as usize)))
.collect::<HashMap<SourceLocation, Vec<TracerData>>>();
let mut tracemap = TraceMap::new();
for (k, val) in &temp_map {
for v in val.iter() {
tracemap.add_trace(&k.path, Trace {
line: k.line,
address: v.address,
length: 1,
stats: CoverageStat::Line(0)
});
}
}
result.merge(&tracemap);
}
}
}
for (file, ref line_analysis) in analysis.iter() {
if config.exclude_path(file) {
continue;
}
for line in &line_analysis.cover {
let line = *line as u64;
if !result.contains_location(file, line) && !line_analysis.should_ignore(&(line as usize)) {
result.add_trace(file, Trace {
line: line,
address: None,
length: 0,
stats: CoverageStat::Line(0),
});
}
}
}
Ok(result)
}
pub fn generate_tracemap(project: &Workspace, test: &Path, config: &Config) -> io::Result<TraceMap> {
let manifest = project.root();
let file = File::open(test)?;
let file = unsafe {
MmapOptions::new().map(&file)?
};
if let Ok(obj) = OFile::parse(&*file) {
let analysis = get_line_analysis(project, config);
let endian = if obj.is_little_endian() {
RunTimeEndian::Little
} else {
RunTimeEndian::Big
};
if let Ok(result) = get_line_addresses(endian, manifest, &obj, &analysis, config) {
Ok(result)
} else {
Err(io::Error::new(io::ErrorKind::InvalidData, "Error while parsing"))
}
} else {
Err(io::Error::new(io::ErrorKind::InvalidData, "Unable to parse binary."))
}
}