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
363
364
365
366
367
368
369
370
371
372
373
374
375
/*
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
use std::collections::HashMap;
use std::hash::Hash;
use super::AsciiOptions;
use super::TreeSpan;
use super::row::Alignment;
use super::row::Row;
use super::row::Rows;
#[derive(Clone)]
pub struct Tree<T>(pub Vec<TreeSpan<T>>);
impl<T> Default for Tree<T> {
fn default() -> Self {
Self(vec![TreeSpan {
children: vec![],
start_time: 0,
duration: 0,
call_count: 1,
extra: None,
}])
}
}
/// Used by `render_ascii_rows` to get the actual columns from a `TreeSpan`.
pub trait DescribeTreeSpan<T> {
fn name(&self, span: &TreeSpan<T>) -> String;
fn source(&self, _span: &TreeSpan<T>) -> String {
String::new()
}
fn source_title(&self) -> String {
"Source".to_string()
}
fn code(&self, _span: &TreeSpan<T>) -> String {
String::new()
}
fn code_title(&self) -> String {
String::new()
}
fn comment(&self, _span: &TreeSpan<T>) -> String {
String::new()
}
fn comment_title(&self) -> String {
String::new()
}
fn blank(&self, _span: &TreeSpan<T>) -> String {
String::new()
}
fn blank_title(&self) -> String {
String::new()
}
fn start(&self, span: &TreeSpan<T>) -> String {
span.start_time.to_string()
}
fn start_title(&self) -> String {
"Start".to_string()
}
fn duration(&self, span: &TreeSpan<T>) -> String {
format!("+{}", span.duration)
}
fn duration_title(&self) -> String {
"Dur.ms".to_string()
}
fn call_count(&self, span: &TreeSpan<T>) -> String {
if span.call_count > 1 {
format!(" ({} times)", span.call_count)
} else {
assert!(span.call_count > 0);
String::new()
}
}
fn extra_metadata_lines(&self, _span: &TreeSpan<T>) -> Vec<String> {
Vec::new()
}
}
impl<T> Tree<T> {
/// Push the given `TreeSpan` as a child of the parent `TreeSpan`.
/// Return the index of the newly pushed `TreeSpan`.
pub fn push(&mut self, parent_span_id: usize, span: TreeSpan<T>) -> usize {
let id = self.0.len();
self.0.push(span);
self.0[parent_span_id].children.push(id);
id
}
/// Merge multiple similar TreeSpans into one larger TreeSpan with
/// a larger `call_count`.
///
/// `extract_key` function extracts a `key` from a TreeSpan.
/// TreeSpans with the same key might be merged.
pub fn merge_children<K: Eq + Hash>(
&mut self,
opts: &AsciiOptions,
extract_key: &impl Fn(&TreeSpan<T>) -> Option<K>,
) {
// For example,
//
// <root>
// |- span 1
// | |- span 2
// | |- span 3
// | |- span 2
// | |- span 3
// | |- span 2
// |- span 2
//
// might be rewritten into:
//
// <root>
// |- span 1
// | |- span 2 (x 3)
// | |- span 3 (x 2)
// |- span 2
struct Context<'a, T> {
tree_spans: &'a mut Vec<TreeSpan<T>>,
opts: &'a AsciiOptions,
}
/// Check children of tree_spans[id] recursively.
fn visit<T, K: Eq + Hash>(
ctx: &mut Context<T>,
id: usize,
extract_key: &impl Fn(&TreeSpan<T>) -> Option<K>,
) {
let mut key_to_id = HashMap::<K, usize>::new();
let child_ids: Vec<usize> = ctx.tree_spans[id].children.to_vec();
for child_id in child_ids {
// Recurse into children, if self is interesting.
// If self is not interesting (will be hidden) then there is no point to process
// children.
if ctx.tree_spans[child_id].is_interesting(ctx.opts, Some(&ctx.tree_spans[id])) {
visit(ctx, child_id, extract_key);
}
// Skip merging if any child is interesting, to avoid accidentically hiding
// interesting children.
if ctx.tree_spans[child_id].children.iter().any(|&id| {
ctx.tree_spans[id].is_interesting(ctx.opts, Some(&ctx.tree_spans[child_id]))
}) {
continue;
}
// Attempt to merge from `child_id` to `existing_child_id`.
if let Some(key) = (extract_key)(&ctx.tree_spans[child_id]) {
let existing_child_id = *key_to_id.entry(key).or_insert(child_id);
if existing_child_id != child_id {
let duration = ctx.tree_spans[child_id].duration;
assert_eq!(ctx.tree_spans[child_id].call_count, 1);
ctx.tree_spans[child_id].call_count -= 1;
let merged = &mut ctx.tree_spans[existing_child_id];
merged.call_count += 1;
merged.duration += duration;
}
}
}
}
let mut context = Context {
opts,
tree_spans: &mut self.0,
};
visit(&mut context, 0, extract_key);
}
/// Render into ASCII `Rows`.
pub fn render_ascii_rows(&self, opts: &AsciiOptions, desc: &dyn DescribeTreeSpan<T>) -> Rows {
struct Context<'a, T> {
opts: &'a AsciiOptions,
tree_spans: &'a [TreeSpan<T>],
desc: &'a dyn DescribeTreeSpan<T>,
}
struct Output {
rows: Vec<Row>,
}
/// Render TreeSpans to rows.
fn render_tree_span<T>(
ctx: &Context<T>,
out: &mut Output,
id: usize,
mut indent: usize,
first_row_ch: char,
include_source: bool,
include_details: bool,
) {
let span = &ctx.tree_spans[id];
if span.is_root() {
return;
}
let name = ctx.desc.name(span);
if !name.is_empty() {
let start = ctx.desc.start(span);
let duration = ctx.desc.duration(span);
let call_count = ctx.desc.call_count(span);
let mut columns = vec![
start.to_string(),
duration,
format!(
"{}{} {}{}",
" ".repeat(indent),
first_row_ch,
name,
call_count
),
];
if include_details {
columns.push(ctx.desc.code(span));
columns.push(ctx.desc.comment(span));
columns.push(ctx.desc.blank(span));
}
if include_source {
columns.push(ctx.desc.source(span));
}
let first_row = Row { columns };
out.rows.push(first_row);
// Extra metadata (other than name and detail columns)
let extra_lines = ctx.desc.extra_metadata_lines(span);
if first_row_ch == '\\' {
indent += 1;
}
for line in extra_lines.iter() {
let mut columns = vec![
String::new(),
String::new(),
format!("{}| {}", " ".repeat(indent), line),
];
if include_details || include_source {
columns.push(":".to_string());
}
if include_details && include_source {
columns.extend([String::new(), String::new(), String::new()]);
} else if include_details || include_source {
columns.extend([String::new(), String::new()]);
}
let row = Row { columns };
out.rows.push(row);
}
}
}
/// Visit a span and its children recursively.
fn visit<T>(
ctx: &Context<T>,
out: &mut Output,
id: usize,
indent: usize,
ch: char,
include_source: bool,
include_details: bool,
) {
// Print out this span.
render_tree_span(ctx, out, id, indent, ch, include_source, include_details);
// Figure out children to visit.
let child_ids: Vec<usize> = ctx.tree_spans[id]
.children
.iter()
.cloned()
.filter(|&child_id| {
ctx.tree_spans[child_id].is_interesting(ctx.opts, Some(&ctx.tree_spans[id]))
})
.collect();
// Preserve a straight line if there is only one child:
//
// | foo ('bar' is the only child)
// | bar <- case 1
//
// Increase indent if there are multi-children (case 2),
// or it's already not a straight line (case 3):
//
// | foo ('bar1' and 'bar2' are children)
// \ bar1 <- case 2
// | bar1.1 <- case 3
// | bar1.2 <- case 1
// \ bar2 <- case 2
// \ bar2.1 <- case 2
// \ bar2.2 <- case 2
//
let (indent, ch) = if child_ids.len() >= 2 {
// case 2
(indent + 1, '\\')
} else if ch == '\\' {
// case 3
(indent + 1, '|')
} else {
// case 1
(indent, '|')
};
for id in child_ids {
visit(ctx, out, id, indent, ch, include_source, include_details)
}
}
let include_source = !desc.source_title().is_empty();
let include_details = !desc.code_title().is_empty()
|| !desc.comment_title().is_empty()
|| !desc.blank_title().is_empty();
let mut columns = vec![
desc.start_title(),
desc.duration_title(),
"| Name".to_string(),
];
if include_details {
columns.push(desc.code_title());
columns.push(desc.comment_title());
columns.push(desc.blank_title());
}
if include_source {
columns.push(desc.source_title());
}
let mut column_alignments = vec![
Alignment::Right, // start time
Alignment::Right, // duration
Alignment::Left, // graph, name
];
if include_details {
column_alignments.extend([Alignment::Right, Alignment::Right, Alignment::Right]);
}
if include_source {
column_alignments.push(Alignment::Left);
}
let mut column_min_widths = vec![4, 4, 20];
let mut column_max_widths = vec![20, 20, 80];
if include_details {
column_min_widths.extend([0, 0, 0]);
column_max_widths.extend([20, 20, 20]);
}
if include_source {
column_min_widths.push(0);
column_max_widths.push(80);
}
let context = Context {
opts,
tree_spans: &self.0,
desc,
};
let mut out = Output {
rows: vec![Row { columns }],
};
visit(
&context,
&mut out,
0,
0,
'|',
include_source,
include_details,
);
Rows {
rows: out.rows,
column_alignments,
column_min_widths,
column_max_widths,
}
}
}