1 /*
2 * Copyright (C) 2015 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 #include "AnimationContext.h"
18 #include "RenderNode.h"
19 #include "renderthread/RenderProxy.h"
20 #include "renderthread/RenderTask.h"
21 #include "tests/common/TestContext.h"
22 #include "tests/common/TestScene.h"
23 #include "tests/common/scenes/TestSceneBase.h"
24
25 #include <benchmark/benchmark.h>
26 #include <gui/Surface.h>
27 #include <log/log.h>
28 #include <ui/PixelFormat.h>
29
30 using namespace android;
31 using namespace android::uirenderer;
32 using namespace android::uirenderer::renderthread;
33 using namespace android::uirenderer::test;
34
35 class ContextFactory : public IContextFactory {
36 public:
createAnimationContext(renderthread::TimeLord & clock)37 virtual AnimationContext* createAnimationContext(renderthread::TimeLord& clock) override {
38 return new AnimationContext(clock);
39 }
40 };
41
42 template <class T>
43 class ModifiedMovingAverage {
44 public:
ModifiedMovingAverage(int weight)45 explicit ModifiedMovingAverage(int weight) : mWeight(weight) {}
46
add(T today)47 T add(T today) {
48 if (!mHasValue) {
49 mAverage = today;
50 } else {
51 mAverage = (((mWeight - 1) * mAverage) + today) / mWeight;
52 }
53 return mAverage;
54 }
55
average()56 T average() { return mAverage; }
57
58 private:
59 bool mHasValue = false;
60 int mWeight;
61 T mAverage;
62 };
63
outputBenchmarkReport(const TestScene::Info & info,const TestScene::Options & opts,benchmark::BenchmarkReporter * reporter,RenderProxy * proxy,double durationInS)64 void outputBenchmarkReport(const TestScene::Info& info, const TestScene::Options& opts,
65 benchmark::BenchmarkReporter* reporter, RenderProxy* proxy,
66 double durationInS) {
67 using namespace benchmark;
68
69 struct ReportInfo {
70 int percentile;
71 const char* suffix;
72 };
73
74 static std::array<ReportInfo, 4> REPORTS = {
75 ReportInfo{50, "_50th"}, ReportInfo{90, "_90th"}, ReportInfo{95, "_95th"},
76 ReportInfo{99, "_99th"},
77 };
78
79 // Although a vector is used, it must stay with only a single element
80 // otherwise the BenchmarkReporter will automatically compute
81 // mean and stddev which doesn't make sense for our usage
82 std::vector<BenchmarkReporter::Run> reports;
83 BenchmarkReporter::Run report;
84 report.benchmark_name = info.name;
85 report.iterations = static_cast<int64_t>(opts.count);
86 report.real_accumulated_time = durationInS;
87 report.cpu_accumulated_time = durationInS;
88 report.items_per_second = opts.count / durationInS;
89 reports.push_back(report);
90 reporter->ReportRuns(reports);
91
92 // Pretend the percentiles are single-iteration runs of the test
93 // If rendering offscreen skip this as it's fps that's more interesting
94 // in that test case than percentiles.
95 if (!opts.renderOffscreen) {
96 for (auto& ri : REPORTS) {
97 reports[0].benchmark_name = info.name;
98 reports[0].benchmark_name += ri.suffix;
99 durationInS = proxy->frameTimePercentile(ri.percentile) / 1000.0;
100 reports[0].real_accumulated_time = durationInS;
101 reports[0].cpu_accumulated_time = durationInS;
102 reports[0].iterations = 1;
103 reports[0].items_per_second = 0;
104 reporter->ReportRuns(reports);
105 }
106 }
107 }
108
run(const TestScene::Info & info,const TestScene::Options & opts,benchmark::BenchmarkReporter * reporter)109 void run(const TestScene::Info& info, const TestScene::Options& opts,
110 benchmark::BenchmarkReporter* reporter) {
111 // Switch to the real display
112 gDisplay = getBuiltInDisplay();
113
114 Properties::forceDrawFrame = true;
115 TestContext testContext;
116 testContext.setRenderOffscreen(opts.renderOffscreen);
117
118 // create the native surface
119 const int width = gDisplay.w;
120 const int height = gDisplay.h;
121 sp<Surface> surface = testContext.surface();
122
123 std::unique_ptr<TestScene> scene(info.createScene(opts));
124 scene->renderTarget = surface;
125
126 sp<RenderNode> rootNode = TestUtils::createNode(
127 0, 0, width, height, [&scene, width, height](RenderProperties& props, Canvas& canvas) {
128 props.setClipToBounds(false);
129 scene->createContent(width, height, canvas);
130 });
131
132 ContextFactory factory;
133 std::unique_ptr<RenderProxy> proxy(new RenderProxy(false, rootNode.get(), &factory));
134 proxy->loadSystemProperties();
135 proxy->initialize(surface);
136 float lightX = width / 2.0;
137 proxy->setup(dp(800.0f), 255 * 0.075, 255 * 0.15);
138 proxy->setLightCenter((Vector3){lightX, dp(-200.0f), dp(800.0f)});
139
140 // Do a few cold runs then reset the stats so that the caches are all hot
141 int warmupFrameCount = 5;
142 if (opts.renderOffscreen) {
143 // Do a few more warmups to try and boost the clocks up
144 warmupFrameCount = 10;
145 }
146 for (int i = 0; i < warmupFrameCount; i++) {
147 testContext.waitForVsync();
148 nsecs_t vsync = systemTime(CLOCK_MONOTONIC);
149 UiFrameInfoBuilder(proxy->frameInfo()).setVsync(vsync, vsync);
150 proxy->syncAndDrawFrame();
151 }
152
153 proxy->resetProfileInfo();
154 proxy->fence();
155
156 ModifiedMovingAverage<double> avgMs(opts.reportFrametimeWeight);
157
158 nsecs_t start = systemTime(CLOCK_MONOTONIC);
159 for (int i = 0; i < opts.count; i++) {
160 testContext.waitForVsync();
161 nsecs_t vsync = systemTime(CLOCK_MONOTONIC);
162 {
163 ATRACE_NAME("UI-Draw Frame");
164 UiFrameInfoBuilder(proxy->frameInfo()).setVsync(vsync, vsync);
165 scene->doFrame(i);
166 proxy->syncAndDrawFrame();
167 }
168 if (opts.reportFrametimeWeight) {
169 proxy->fence();
170 nsecs_t done = systemTime(CLOCK_MONOTONIC);
171 avgMs.add((done - vsync) / 1000000.0);
172 if (i % 10 == 9) {
173 printf("Average frametime %.3fms\n", avgMs.average());
174 }
175 }
176 }
177 proxy->fence();
178 nsecs_t end = systemTime(CLOCK_MONOTONIC);
179
180 if (reporter) {
181 outputBenchmarkReport(info, opts, reporter, proxy.get(), (end - start) / (double)s2ns(1));
182 } else {
183 proxy->dumpProfileInfo(STDOUT_FILENO, DumpFlags::JankStats);
184 }
185 }
186