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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
|
#!/usr/bin/python
#
# Copyright 2016 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
#
"""Generates an HTML file with plot of buffer level in the audio thread log."""
import argparse
import collections
import logging
import string
import time
page_content = string.Template("""
<html meta charset="UTF8">
<head>
<!-- Load c3.css -->
<link href="https://rawgit.com/masayuki0812/c3/master/c3.css" rel="stylesheet" type="text/css">
<!-- Load d3.js and c3.js -->
<script src="https://d3js.org/d3.v4.min.js" charset="utf-8"></script>
<script src="https://rawgit.com/masayuki0812/c3/master/c3.js" charset="utf-8"></script>
<style type="text/css">
.c3-grid text {
fill: grey;
}
.event_log_box {
font-family: 'Courier New', Courier, 'Lucida Sans Typewriter', 'Lucida Typewriter', monospace;
font-size: 20px;
font-style: normal;
font-variant: normal;
font-weight: 300;
line-height: 26.4px;
white-space: pre;
height:50%;
width:48%;
border:1px solid #ccc;
overflow:auto;
}
.checkbox {
font-size: 30px;
border: 2px;
}
.device {
font-size: 15px;
}
.stream{
font-size: 15px;
}
.fetch{
}
.wake{
}
</style>
<script type="text/javascript">
var selected = null;
draw_chart = function() {
var chart = c3.generate({
data: {
x: 'time',
columns: [
['time', $times],
['buffer_level', $buffer_levels],
],
type: 'bar',
types: {
buffer_level: 'line',
},
onclick: function (d, i) {
elm = document.getElementById(d.x.toFixed(9));
if (selected)
selected.style.color = '';
if (elm === null) {
console.error("Can not find element by ID %s", d.x.toFixed(9));
return;
}
elm.style.color = 'blue';
elm.scrollIntoView();
selected = elm;
},
},
zoom: {
enabled: true,
},
grid: {
x: {
lines: [
$grids,
],
},
},
axis: {
y: {min: 0, max: $max_y},
},
});
};
logs = `$logs`;
put_logs = function () {
document.getElementById('logs').innerHTML = logs;
};
set_initial_checkbox_value = function () {
document.getElementById('device').checked = true;
document.getElementById('stream').checked = true;
document.getElementById('fetch').checked = true;
document.getElementById('wake').checked = true;
}
window.onload = function() {
draw_chart();
put_logs();
set_initial_checkbox_value();
};
function handleClick(checkbox) {
var class_name = checkbox.id;
var elements = document.getElementsByClassName(class_name);
var i;
if (checkbox.checked) {
display_value = "block";
} else {
display_value = "none"
}
console.log("change " + class_name + " to " + display_value);
for (i = 0; i < elements.length; i++) {
elements[i].style.display = display_value;
}
}
</script>
</head>
<body>
<div id="chart" style="height:50%; width:100%" ></div>
<div style="margin:0 auto"; class="checkbox">
<label><input type="checkbox" onclick="handleClick(this);" id="device">Show device removed/added event</label>
<label><input type="checkbox" onclick="handleClick(this);" id="stream">Show stream removed/added event</label>
<label><input type="checkbox" onclick="handleClick(this);" id="fetch">Show fetch event</label>
<label><input type="checkbox" onclick="handleClick(this);" id="wake">Show wake by num_fds=1 event</label>
</div>
<div class="event_log_box", id="logs", style="float:left;"></div>
<textarea class="event_log_box", id="text", style="float:right;"></textarea>
</body>
</html>
""")
def StrToTimestamp(s):
"""Converts a time string to a timestamp.
@param s: A time string like "2019-07-02T15:30:46.684190644".
@returns: Returns a timestamp string like "55846.684190644".
"""
fmt = "%Y-%m-%dT%H:%M:%S"
t = time.strptime(s[:-10], fmt)
# Ignore date to avoid a long timestamp.
ts = t.tm_hour * 3600 + t.tm_min * 60 + t.tm_sec
return "{:d}.{}".format(ts, s[-9:])
Tag = collections.namedtuple('Tag', ['time', 'text', 'position', 'class_name'])
"""
The tuple for tags shown on the plot on certain time.
text is the tag to show, position is the tag position, which is one of
'start', 'middle', 'end', class_name is one of 'device', 'stream', 'fetch',
and 'wake' which will be their CSS class name.
"""
class EventData(object):
"""The base class of an event."""
def __init__(self, time, name):
"""Initializes an EventData.
@param time: A string for event time.
@param name: A string for event name.
"""
self.time = time
self.name = name
self._text = None
self._position = None
self._class_name = None
def GetTag(self):
"""Gets the tag for this event.
@returns: A Tag object. Returns None if no need to show tag.
"""
if self._text:
return Tag(
time=self.time, text=self._text, position=self._position,
class_name=self._class_name)
return None
class DeviceEvent(EventData):
"""Class for device event."""
def __init__(self, time, name, device):
"""Initializes a DeviceEvent.
@param time: A string for event time.
@param name: A string for event name.
@param device: A string for device index.
"""
super(DeviceEvent, self).__init__(time, name)
self.device = device
self._position = 'start'
self._class_name = 'device'
class DeviceRemovedEvent(DeviceEvent):
"""Class for device removed event."""
def __init__(self, time, name, device):
"""Initializes a DeviceRemovedEvent.
@param time: A string for event time.
@param name: A string for event name.
@param device: A string for device index.
"""
super(DeviceRemovedEvent, self).__init__(time, name, device)
self._text = 'Removed Device %s' % self.device
class DeviceAddedEvent(DeviceEvent):
"""Class for device added event."""
def __init__(self, time, name, device):
"""Initializes a DeviceAddedEvent.
@param time: A string for event time.
@param name: A string for event name.
@param device: A string for device index.
"""
super(DeviceAddedEvent, self).__init__(time, name, device)
self._text = 'Added Device %s' % self.device
class LevelEvent(DeviceEvent):
"""Class for device event with buffer level."""
def __init__(self, time, name, device, level):
"""Initializes a LevelEvent.
@param time: A string for event time.
@param name: A string for event name.
@param device: A string for device index.
@param level: An int for buffer level.
"""
super(LevelEvent, self).__init__(time, name, device)
self.level = level
class StreamEvent(EventData):
"""Class for event with stream."""
def __init__(self, time, name, stream):
"""Initializes a StreamEvent.
@param time: A string for event time.
@param name: A string for event name.
@param stream: A string for stream id.
"""
super(StreamEvent, self).__init__(time, name)
self.stream = stream
self._class_name = 'stream'
class FetchStreamEvent(StreamEvent):
"""Class for stream fetch event."""
def __init__(self, time, name, stream):
"""Initializes a FetchStreamEvent.
@param time: A string for event time.
@param name: A string for event name.
@param stream: A string for stream id.
"""
super(FetchStreamEvent, self).__init__(time, name, stream)
self._text = 'Fetch %s' % self.stream
self._position = 'end'
self._class_name = 'fetch'
class StreamAddedEvent(StreamEvent):
"""Class for stream added event."""
def __init__(self, time, name, stream):
"""Initializes a StreamAddedEvent.
@param time: A string for event time.
@param name: A string for event name.
@param stream: A string for stream id.
"""
super(StreamAddedEvent, self).__init__(time, name, stream)
self._text = 'Add stream %s' % self.stream
self._position = 'middle'
class StreamRemovedEvent(StreamEvent):
"""Class for stream removed event."""
def __init__(self, time, name, stream):
"""Initializes a StreamRemovedEvent.
@param time: A string for event time.
@param name: A string for event name.
@param stream: A string for stream id.
"""
super(StreamRemovedEvent, self).__init__(time, name, stream)
self._text = 'Remove stream %s' % self.stream
self._position = 'middle'
class WakeEvent(EventData):
"""Class for wake event."""
def __init__(self, time, name, num_fds):
"""Initializes a WakeEvent.
@param time: A string for event time.
@param name: A string for event name.
@param num_fds: A string for number of fd that wakes audio thread up.
"""
super(WakeEvent, self).__init__(time, name)
self._position = 'middle'
self._class_name = 'wake'
if num_fds != '0':
self._text = 'num_fds %s' % num_fds
class C3LogWriter(object):
"""Class to handle event data and fill an HTML page using c3.js library"""
def __init__(self):
"""Initializes a C3LogWriter."""
self.times = []
self.buffer_levels = []
self.tags = []
self.max_y = 0
def AddEvent(self, event):
"""Digests an event.
Add a tag if this event needs to be shown on grid.
Add a buffer level data into buffer_levels if this event has buffer
level.
@param event: An EventData object.
"""
tag = event.GetTag()
if tag:
self.tags.append(tag)
if isinstance(event, LevelEvent):
self.times.append(event.time)
self.buffer_levels.append(str(event.level))
if event.level > self.max_y:
self.max_y = event.level
logging.debug('add data for a level event %s: %s',
event.time, event.level)
if (isinstance(event, DeviceAddedEvent) or
isinstance(event, DeviceRemovedEvent)):
self.times.append(event.time)
self.buffer_levels.append('null')
def _GetGrids(self):
"""Gets the content to be filled for grids.
@returns: A str for grid with format:
'{value: time1, text: "tag1", position: "position1"},
{value: time1, text: "tag1"},...'
"""
grids = []
for tag in self.tags:
content = ('{value: %s, text: "%s", position: "%s", '
'class: "%s"}') % (
tag.time, tag.text, tag.position, tag.class_name)
grids.append(content)
grids_joined = ', '.join(grids)
return grids_joined
def FillPage(self, page_template):
"""Fills in the page template with content.
@param page_template: A string for HTML page content with variables
to be filled.
@returns: A string for filled page.
"""
times = ', '.join(self.times)
buffer_levels = ', '.join(self.buffer_levels)
grids = self._GetGrids()
filled = page_template.safe_substitute(
times=times,
buffer_levels=buffer_levels,
grids=grids,
max_y=str(self.max_y))
return filled
class EventLogParser(object):
"""Class for event log parser."""
def __init__(self):
"""Initializes an EventLogParse."""
self.parsed_events = []
def AddEventLog(self, event_log):
"""Digests a line of event log.
@param event_log: A line for event log.
"""
event = self._ParseOneLine(event_log)
if event:
self.parsed_events.append(event)
def GetParsedEvents(self):
"""Gets the list of parsed events.
@returns: A list of parsed EventData.
"""
return self.parsed_events
def _ParseOneLine(self, line):
"""Parses one line of event log.
Split a line like
2019-07-02T15:30:46.683829810 cras atlog WRITE_STREAMS_FETCH_STREAM id:1e0000 cbth:512 delay:1136
into time, name, and props where
time = '54946.683829810'
name = 'WRITE_STREAMS_FETCH_STREAM'
props = {
'id': 0,
'cb_th': 512,
'delay': 1136
}
@param line: A line of event log.
@returns: A EventData object.
"""
line_split = line.split()
time, name = StrToTimestamp(line_split[0]), line_split[3]
logging.debug('time: %s, name: %s', time, name)
props = {}
for index in xrange(4, len(line_split)):
key, value = line_split[index].split(':')[:2]
props[key] = value
logging.debug('props: %s', props)
return self._CreateEventData(time, name, props)
def _CreateEventData(self, time, name, props):
"""Creates an EventData based on event name.
@param time: A string for event time.
@param name: A string for event name.
@param props: A dict for event properties.
@returns: A EventData object.
"""
if name == 'WRITE_STREAMS_FETCH_STREAM':
return FetchStreamEvent(time, name, stream=props['id'])
if name == 'STREAM_ADDED':
return StreamAddedEvent(time, name, stream=props['id'])
if name == 'STREAM_REMOVED':
return StreamRemovedEvent(time, name, stream=props['id'])
if name in ['FILL_AUDIO', 'SET_DEV_WAKE']:
return LevelEvent(
time, name, device=props['dev'],
level=int(props['hw_level']))
if name == 'DEV_ADDED':
return DeviceAddedEvent(time, name, device=props['dev'])
if name == 'DEV_REMOVED':
return DeviceRemovedEvent(time, name, device=props['dev'])
if name == 'WAKE':
return WakeEvent(time, name, num_fds=props['num_fds'])
return None
class AudioThreadLogParser(object):
"""Class for audio thread log parser."""
def __init__(self, path):
"""Initializes an AudioThreadLogParser.
@param path: The audio thread log file path.
"""
self.path = path
self.content = None
def Parse(self):
"""Prases the audio thread logs.
@returns: A list of event log lines.
"""
logging.debug('Using file: %s', self.path)
with open(self.path, 'r') as f:
self.content = f.read().splitlines()
# Event logs starting at two lines after 'Audio Thread Event Log'.
index_start = self.content.index('Audio Thread Event Log:') + 2
# If input is from audio_diagnostic result, use aplay -l line to find
# the end of audio thread event logs.
try:
index_end = self.content.index('=== aplay -l ===')
except ValueError:
logging.debug(
'Can not find aplay line. This is not from diagnostic')
index_end = len(self.content)
event_logs = self.content[index_start:index_end]
logging.info('Parsed %s log events', len(event_logs))
return event_logs
def FillLogs(self, page_template):
"""Fills the HTML page template with contents for audio thread logs.
@param page_template: A string for HTML page content with log variable
to be filled.
@returns: A string for filled page.
"""
logs = []
for s in self.content:
if 'atlog' in s:
time = StrToTimestamp(s.split()[0])
logs.append('<label id="{}">{}</label>'.format(time, s))
else:
logs.append(s)
logs = '\n'.join(logs)
return page_template.substitute(logs=logs)
def ParseArgs():
"""Parses the arguments.
@returns: The namespace containing parsed arguments.
"""
parser = argparse.ArgumentParser(
description='Draw time chart from audio thread log',
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
parser.add_argument('FILE', type=str, help='The audio thread log file')
parser.add_argument('-o', type=str, dest='output',
default='view.html', help='The output HTML file')
parser.add_argument('-d', dest='debug', action='store_true',
default=False, help='Show debug message')
return parser.parse_args()
def Main():
"""The Main program."""
options = ParseArgs()
logging.basicConfig(
format='%(asctime)s:%(levelname)s:%(message)s',
level=logging.DEBUG if options.debug else logging.INFO)
# Gets lines of event logs.
audio_thread_log_parser = AudioThreadLogParser(options.FILE)
event_logs = audio_thread_log_parser.Parse()
# Parses event logs into events.
event_log_parser = EventLogParser()
for event_log in event_logs:
event_log_parser.AddEventLog(event_log)
events = event_log_parser.GetParsedEvents()
# Reads in events in preparation of filling HTML template.
c3_writer = C3LogWriter()
for event in events:
c3_writer.AddEvent(event)
# Fills in buffer level chart.
page_content_with_chart = c3_writer.FillPage(page_content)
# Fills in audio thread log into text box.
page_content_with_chart_and_logs = audio_thread_log_parser.FillLogs(
string.Template(page_content_with_chart))
with open(options.output, 'w') as f:
f.write(page_content_with_chart_and_logs)
if __name__ == '__main__':
Main()
|
