Skip to content

F
Front-End
Commit 2aead430 authored by Yegor's avatar Yegor Committed by GitHub
Browse files
Options

add GPU traces to timeline summary (#7190)

parent 9eaaa91d
Hide whitespace changes
Inline Side-by-side
Showing with 206 additions and 49 deletions
packages/flutter_driver/lib/src/timeline_summary.dart
View file @ 2aead430
......@@ -30,58 +30,61 @@ class TimelineSummary {
///
/// Returns `null` if no frames were recorded.
double computeAverageFrameBuildTimeMillis() {
int totalBuildTimeMicros = 0;
int frameCount = 0;
for (TimedEvent event in _extractFrameEvents()) {
frameCount++;
totalBuildTimeMicros += event.duration.inMicroseconds;
}
return frameCount > 0
? (totalBuildTimeMicros / frameCount) / 1000
: null;
return _averageDurationInMillis(_extractFrameEvents());
}
/// Find amount of time spent in the framework building widgets,
/// updating layout, painting and compositing on worst frame.
/// The longest frame build time in milliseconds.
///
/// Returns `null` if no frames were recorded.
double computeWorstFrameBuildTimeMillis() {
int maxBuildTimeMicros = 0;
int frameCount = 0;
for (TimedEvent event in _extractFrameEvents()) {
frameCount++;
maxBuildTimeMicros = math.max(maxBuildTimeMicros, event.duration.inMicroseconds);
}
return frameCount > 0
? maxBuildTimeMicros / 1000
: null;
return _maxDurationInMillis(_extractFrameEvents());
}
/// The total number of frames recorded in the timeline.
int countFrames() => _extractFrameEvents().length;
/// The number of frames that missed the [frameBuildBudget] and therefore are
/// The number of frames that missed the [kBuildBudget] and therefore are
/// in the danger of missing frames.
///
/// See [kBuildBudget].
int computeMissedFrameBuildBudgetCount([Duration frameBuildBudget = kBuildBudget]) => _extractFrameEvents()
.where((TimedEvent event) => event.duration > kBuildBudget)
.length;
/// Average amount of time spent per frame in the GPU rasterizer.
///
/// Returns `null` if no frames were recorded.
double computeAverageFrameRasterizerTimeMillis() {
return _averageDurationInMillis(_extractGpuRasterizerDrawEvents());
}
/// The longest frame rasterization time in milliseconds.
///
/// Returns `null` if no frames were recorded.
double computeWorstFrameRasterizerTimeMillis() {
return _maxDurationInMillis(_extractGpuRasterizerDrawEvents());
}
/// The number of frames that missed the [kBuildBudget] on the GPU and
/// therefore are in the danger of missing frames.
int computeMissedFrameRasterizerBudgetCount([Duration frameBuildBudget = kBuildBudget]) => _extractGpuRasterizerDrawEvents()
.where((TimedEvent event) => event.duration > kBuildBudget)
.length;
/// The total number of frames recorded in the timeline.
int countFrames() => _extractFrameEvents().length;
/// Encodes this summary as JSON.
Map<String, dynamic> get summaryJson {
return <String, dynamic> {
'average_frame_build_time_millis': computeAverageFrameBuildTimeMillis(),
'worst_frame_build_time_millis': computeWorstFrameBuildTimeMillis(),
'missed_frame_build_budget_count': computeMissedFrameBuildBudgetCount(),
'average_frame_rasterizer_time_millis': computeAverageFrameRasterizerTimeMillis(),
'worst_frame_rasterizer_time_millis': computeWorstFrameRasterizerTimeMillis(),
'missed_frame_rasterizer_budget_count': computeMissedFrameRasterizerBudgetCount(),
'frame_count': countFrames(),
'frame_build_times': _extractFrameEvents()
.map((TimedEvent event) => event.duration.inMicroseconds)
.toList()
.toList(),
'frame_rasterizer_times': _extractGpuRasterizerDrawEvents()
.map((TimedEvent event) => event.duration.inMicroseconds)
.toList(),
};
}
......@@ -130,7 +133,48 @@ class TimelineSummary {
.toList();
}
/// Extracts timed events that are reported as a pair of begin/end events.
///
/// See: https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU
List<TimedEvent> _extractBeginEndEvents(String name) {
List<TimedEvent> result = <TimedEvent>[];
// Timeline does not guarantee that the first event is the "begin" event.
Iterator<TimelineEvent> events = _extractNamedEvents(name)
.skipWhile((TimelineEvent evt) => evt.phase != 'B').iterator;
while(events.moveNext()) {
TimelineEvent beginEvent = events.current;
if (events.moveNext()) {
TimelineEvent endEvent = events.current;
result.add(new TimedEvent(
beginEvent.timestampMicros,
endEvent.timestampMicros
));
}
}
return result;
}
double _averageDurationInMillis(List<TimedEvent> events) {
if (events.length == 0)
return null;
int total = events.fold/*<int>*/(0, (int t, TimedEvent e) => t + e.duration.inMilliseconds);
return total / events.length;
}
double _maxDurationInMillis(List<TimedEvent> events) {
if (events.length == 0)
return null;
return events
.map/*<double>*/((TimedEvent e) => e.duration.inMilliseconds.toDouble())
.reduce((double a, double b) => math.max(a, b));
}
List<TimedEvent> _extractFrameEvents() => _extractCompleteEvents('Frame');
List<TimedEvent> _extractGpuRasterizerDrawEvents() => _extractBeginEndEvents('GPURasterizer::Draw');
}
/// Timing information about an event that happened in the event loop.
......
packages/flutter_driver/test/src/timeline_summary_test.dart
View file @ 2aead430
......@@ -17,16 +17,24 @@ void main() {
}));
}
Map<String, dynamic> frame(int timeStamp, int duration) => <String, dynamic>{
Map<String, dynamic> build(int timeStamp, int duration) => <String, dynamic>{
'name': 'Frame', 'ph': 'X', 'ts': timeStamp, 'dur': duration
};
Map<String, dynamic> begin(int timeStamp) => <String, dynamic>{
'name': 'GPURasterizer::Draw', 'ph': 'B', 'ts': timeStamp
};
Map<String, dynamic> end(int timeStamp) => <String, dynamic>{
'name': 'GPURasterizer::Draw', 'ph': 'E', 'ts': timeStamp
};
group('frame_count', () {
test('counts frames', () {
expect(
summarize(<Map<String, dynamic>>[
frame(1000, 1000),
frame(3000, 2000),
build(1000, 1000),
build(3000, 2000),
]).countFrames(),
2
);
......@@ -41,8 +49,8 @@ void main() {
test('computes average frame build time in milliseconds', () {
expect(
summarize(<Map<String, dynamic>>[
frame(1000, 1000),
frame(3000, 2000),
build(1000, 1000),
build(3000, 2000),
]).computeAverageFrameBuildTimeMillis(),
1.5
);
......@@ -57,15 +65,15 @@ void main() {
test('computes worst frame build time in milliseconds', () {
expect(
summarize(<Map<String, dynamic>>[
frame(1000, 1000),
frame(3000, 2000),
build(1000, 1000),
build(3000, 2000),
]).computeWorstFrameBuildTimeMillis(),
2.0
);
expect(
summarize(<Map<String, dynamic>>[
frame(3000, 2000),
frame(1000, 1000),
build(3000, 2000),
build(1000, 1000),
]).computeWorstFrameBuildTimeMillis(),
2.0
);
......@@ -75,9 +83,9 @@ void main() {
group('computeMissedFrameBuildBudgetCount', () {
test('computes the number of missed build budgets', () {
TimelineSummary summary = summarize(<Map<String, dynamic>>[
frame(1000, 9000),
frame(11000, 1000),
frame(13000, 10000),
build(1000, 9000),
build(11000, 1000),
build(13000, 10000),
]);
expect(summary.countFrames(), 3);
......@@ -85,20 +93,118 @@ void main() {
});
});
group('average_frame_rasterizer_time_millis', () {
test('returns null when there is no data', () {
expect(summarize(<Map<String, dynamic>>[]).computeAverageFrameRasterizerTimeMillis(), isNull);
});
test('computes average frame rasterizer time in milliseconds', () {
expect(
summarize(<Map<String, dynamic>>[
begin(1000), end(2000),
begin(3000), end(5000),
]).computeAverageFrameRasterizerTimeMillis(),
1.5
);
});
test('skips leading "end" events', () {
expect(
summarize(<Map<String, dynamic>>[
end(1000),
begin(2000), end(4000),
]).computeAverageFrameRasterizerTimeMillis(),
2.0
);
});
test('skips trailing "begin" events', () {
expect(
summarize(<Map<String, dynamic>>[
begin(2000), end(4000),
begin(5000),
]).computeAverageFrameRasterizerTimeMillis(),
2.0
);
});
});
group('worst_frame_rasterizer_time_millis', () {
test('returns null when there is no data', () {
expect(summarize(<Map<String, dynamic>>[]).computeWorstFrameRasterizerTimeMillis(), isNull);
});
test('computes worst frame rasterizer time in milliseconds', () {
expect(
summarize(<Map<String, dynamic>>[
begin(1000), end(2000),
begin(3000), end(5000),
]).computeWorstFrameRasterizerTimeMillis(),
2.0
);
expect(
summarize(<Map<String, dynamic>>[
begin(3000), end(5000),
begin(1000), end(2000),
]).computeWorstFrameRasterizerTimeMillis(),
2.0
);
});
test('skips leading "end" events', () {
expect(
summarize(<Map<String, dynamic>>[
end(1000),
begin(2000), end(4000),
]).computeWorstFrameRasterizerTimeMillis(),
2.0
);
});
test('skips trailing "begin" events', () {
expect(
summarize(<Map<String, dynamic>>[
begin(2000), end(4000),
begin(5000),
]).computeWorstFrameRasterizerTimeMillis(),
2.0
);
});
});
group('computeMissedFrameRasterizerBudgetCount', () {
test('computes the number of missed rasterizer budgets', () {
TimelineSummary summary = summarize(<Map<String, dynamic>>[
begin(1000), end(10000),
begin(11000), end(12000),
begin(13000), end(23000),
]);
expect(summary.computeMissedFrameRasterizerBudgetCount(), 2);
});
});
group('summaryJson', () {
test('computes and returns summary as JSON', () {
expect(
summarize(<Map<String, dynamic>>[
frame(1000, 9000),
frame(11000, 1000),
frame(13000, 11000),
begin(1000), end(11000),
begin(11000), end(13000),
begin(13000), end(25000),
build(1000, 9000),
build(11000, 1000),
build(13000, 11000),
]).summaryJson,
<String, dynamic>{
'average_frame_build_time_millis': 7.0,
'worst_frame_build_time_millis': 11.0,
'missed_frame_build_budget_count': 2,
'average_frame_rasterizer_time_millis': 8.0,
'worst_frame_rasterizer_time_millis': 12.0,
'missed_frame_rasterizer_budget_count': 2,
'frame_count': 3,
'frame_build_times': <int>[9000, 1000, 11000],
'frame_rasterizer_times': <int>[10000, 2000, 12000],
}
);
});
......@@ -123,9 +229,12 @@ void main() {
test('writes summary to JSON file', () async {
await summarize(<Map<String, dynamic>>[
frame(1000, 9000),
frame(11000, 1000),
frame(13000, 11000),
begin(1000), end(11000),
begin(11000), end(13000),
begin(13000), end(25000),
build(1000, 9000),
build(11000, 1000),
build(13000, 11000),
]).writeSummaryToFile('test', destinationDirectory: '/temp');
String written =
await fs.file('/temp/test.timeline_summary.json').readAsString();
......@@ -133,8 +242,12 @@ void main() {
'average_frame_build_time_millis': 7.0,
'worst_frame_build_time_millis': 11.0,
'missed_frame_build_budget_count': 2,
'average_frame_rasterizer_time_millis': 8.0,
'worst_frame_rasterizer_time_millis': 12.0,
'missed_frame_rasterizer_budget_count': 2,
'frame_count': 3,
'frame_build_times': <int>[9000, 1000, 11000],
'frame_rasterizer_times': <int>[10000, 2000, 12000],
});
});
});
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

HIAST - GitLab