blob: 9e01fd0d8d329083f2b824ba6356e9002cd7ee96 [file] [log] [blame]
Jamie Gennisfaf77cc2013-07-30 15:10:32 -07001/*
2 * Copyright (C) 2013 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#define ATRACE_TAG ATRACE_TAG_GRAPHICS
Tim Murray4a4e4a22016-04-19 16:29:23 +000018//#define LOG_NDEBUG 0
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070019
20// This is needed for stdint.h to define INT64_MAX in C++
21#define __STDC_LIMIT_MACROS
22
23#include <math.h>
24
Mark Salyzyna5e161b2016-09-29 08:08:05 -070025#include <algorithm>
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070026
Mark Salyzyn7823e122016-09-29 08:08:05 -070027#include <log/log.h>
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070028#include <utils/String8.h>
29#include <utils/Thread.h>
30#include <utils/Trace.h>
31#include <utils/Vector.h>
32
Brian Andersonfbc80ae2017-05-26 16:23:54 -070033#include <ui/FenceTime.h>
Mark Salyzyna5e161b2016-09-29 08:08:05 -070034
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070035#include "DispSync.h"
36#include "EventLog/EventLog.h"
Lloyd Pique78ce4182018-01-31 16:39:51 -080037#include "SurfaceFlinger.h"
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070038
Tim Murray4a4e4a22016-04-19 16:29:23 +000039using std::max;
40using std::min;
41
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070042namespace android {
43
44// Setting this to true enables verbose tracing that can be used to debug
45// vsync event model or phase issues.
Andy McFadden5167ec62014-05-22 13:08:43 -070046static const bool kTraceDetailedInfo = false;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070047
Tim Murray4a4e4a22016-04-19 16:29:23 +000048// Setting this to true adds a zero-phase tracer for correlating with hardware
49// vsync events
50static const bool kEnableZeroPhaseTracer = false;
51
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070052// This is the threshold used to determine when hardware vsync events are
53// needed to re-synchronize the software vsync model with the hardware. The
54// error metric used is the mean of the squared difference between each
55// present time and the nearest software-predicted vsync.
Lloyd Pique78ce4182018-01-31 16:39:51 -080056static const nsecs_t kErrorThreshold = 160000000000; // 400 usec squared
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070057
Tim Murray4a4e4a22016-04-19 16:29:23 +000058#undef LOG_TAG
59#define LOG_TAG "DispSyncThread"
Lloyd Pique78ce4182018-01-31 16:39:51 -080060class DispSyncThread : public Thread {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070061public:
Lloyd Pique78ce4182018-01-31 16:39:51 -080062 explicit DispSyncThread(const char* name)
63 : mName(name),
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070064 mStop(false),
65 mPeriod(0),
66 mPhase(0),
Haixia Shi676b1f62015-10-28 16:19:01 -070067 mReferenceTime(0),
Tim Murray4a4e4a22016-04-19 16:29:23 +000068 mWakeupLatency(0),
69 mFrameNumber(0) {}
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070070
71 virtual ~DispSyncThread() {}
72
Haixia Shi676b1f62015-10-28 16:19:01 -070073 void updateModel(nsecs_t period, nsecs_t phase, nsecs_t referenceTime) {
Tim Murray4a4e4a22016-04-19 16:29:23 +000074 if (kTraceDetailedInfo) ATRACE_CALL();
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070075 Mutex::Autolock lock(mMutex);
76 mPeriod = period;
77 mPhase = phase;
Haixia Shi676b1f62015-10-28 16:19:01 -070078 mReferenceTime = referenceTime;
Tim Murray4a4e4a22016-04-19 16:29:23 +000079 ALOGV("[%s] updateModel: mPeriod = %" PRId64 ", mPhase = %" PRId64
Lloyd Pique78ce4182018-01-31 16:39:51 -080080 " mReferenceTime = %" PRId64,
81 mName, ns2us(mPeriod), ns2us(mPhase), ns2us(mReferenceTime));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070082 mCond.signal();
83 }
84
85 void stop() {
Tim Murray4a4e4a22016-04-19 16:29:23 +000086 if (kTraceDetailedInfo) ATRACE_CALL();
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070087 Mutex::Autolock lock(mMutex);
88 mStop = true;
89 mCond.signal();
90 }
91
92 virtual bool threadLoop() {
93 status_t err;
94 nsecs_t now = systemTime(SYSTEM_TIME_MONOTONIC);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070095
96 while (true) {
97 Vector<CallbackInvocation> callbackInvocations;
98
99 nsecs_t targetTime = 0;
100
101 { // Scope for lock
102 Mutex::Autolock lock(mMutex);
103
Tim Murray4a4e4a22016-04-19 16:29:23 +0000104 if (kTraceDetailedInfo) {
105 ATRACE_INT64("DispSync:Frame", mFrameNumber);
106 }
107 ALOGV("[%s] Frame %" PRId64, mName, mFrameNumber);
108 ++mFrameNumber;
109
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700110 if (mStop) {
111 return false;
112 }
113
114 if (mPeriod == 0) {
115 err = mCond.wait(mMutex);
116 if (err != NO_ERROR) {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800117 ALOGE("error waiting for new events: %s (%d)", strerror(-err), err);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700118 return false;
119 }
120 continue;
121 }
122
Dan Stoza8f8374d2016-04-19 10:03:46 -0700123 targetTime = computeNextEventTimeLocked(now);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700124
125 bool isWakeup = false;
126
127 if (now < targetTime) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000128 if (kTraceDetailedInfo) ATRACE_NAME("DispSync waiting");
Dan Stoza8f8374d2016-04-19 10:03:46 -0700129
130 if (targetTime == INT64_MAX) {
131 ALOGV("[%s] Waiting forever", mName);
132 err = mCond.wait(mMutex);
133 } else {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800134 ALOGV("[%s] Waiting until %" PRId64, mName, ns2us(targetTime));
Dan Stoza8f8374d2016-04-19 10:03:46 -0700135 err = mCond.waitRelative(mMutex, targetTime - now);
136 }
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700137
138 if (err == TIMED_OUT) {
139 isWakeup = true;
140 } else if (err != NO_ERROR) {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800141 ALOGE("error waiting for next event: %s (%d)", strerror(-err), err);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700142 return false;
143 }
144 }
145
146 now = systemTime(SYSTEM_TIME_MONOTONIC);
147
Tim Murray4a4e4a22016-04-19 16:29:23 +0000148 // Don't correct by more than 1.5 ms
149 static const nsecs_t kMaxWakeupLatency = us2ns(1500);
150
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700151 if (isWakeup) {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800152 mWakeupLatency = ((mWakeupLatency * 63) + (now - targetTime)) / 64;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000153 mWakeupLatency = min(mWakeupLatency, kMaxWakeupLatency);
Andy McFadden5167ec62014-05-22 13:08:43 -0700154 if (kTraceDetailedInfo) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000155 ATRACE_INT64("DispSync:WakeupLat", now - targetTime);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700156 ATRACE_INT64("DispSync:AvgWakeupLat", mWakeupLatency);
157 }
158 }
159
160 callbackInvocations = gatherCallbackInvocationsLocked(now);
161 }
162
163 if (callbackInvocations.size() > 0) {
Andy McFadden645b1f72014-06-10 14:43:32 -0700164 fireCallbackInvocations(callbackInvocations);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700165 }
166 }
167
168 return false;
169 }
170
Lloyd Piquee83f9312018-02-01 12:53:17 -0800171 status_t addEventListener(const char* name, nsecs_t phase, DispSync::Callback* callback) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000172 if (kTraceDetailedInfo) ATRACE_CALL();
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700173 Mutex::Autolock lock(mMutex);
174
175 for (size_t i = 0; i < mEventListeners.size(); i++) {
176 if (mEventListeners[i].mCallback == callback) {
177 return BAD_VALUE;
178 }
179 }
180
181 EventListener listener;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000182 listener.mName = name;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700183 listener.mPhase = phase;
184 listener.mCallback = callback;
Jamie Gennis629b9872013-10-29 13:36:12 -0700185
186 // We want to allow the firstmost future event to fire without
Tim Murray4a4e4a22016-04-19 16:29:23 +0000187 // allowing any past events to fire
Lloyd Pique78ce4182018-01-31 16:39:51 -0800188 listener.mLastEventTime = systemTime() - mPeriod / 2 + mPhase - mWakeupLatency;
Jamie Gennis629b9872013-10-29 13:36:12 -0700189
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700190 mEventListeners.push(listener);
191
192 mCond.signal();
193
194 return NO_ERROR;
195 }
196
Lloyd Piquee83f9312018-02-01 12:53:17 -0800197 status_t removeEventListener(DispSync::Callback* callback) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000198 if (kTraceDetailedInfo) ATRACE_CALL();
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700199 Mutex::Autolock lock(mMutex);
200
201 for (size_t i = 0; i < mEventListeners.size(); i++) {
202 if (mEventListeners[i].mCallback == callback) {
203 mEventListeners.removeAt(i);
204 mCond.signal();
205 return NO_ERROR;
206 }
207 }
208
209 return BAD_VALUE;
210 }
211
Fabien Sanglardcbf153b2017-03-10 17:57:12 -0800212 // This method is only here to handle the !SurfaceFlinger::hasSyncFramework
213 // case.
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700214 bool hasAnyEventListeners() {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000215 if (kTraceDetailedInfo) ATRACE_CALL();
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700216 Mutex::Autolock lock(mMutex);
217 return !mEventListeners.empty();
218 }
219
220private:
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700221 struct EventListener {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000222 const char* mName;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700223 nsecs_t mPhase;
224 nsecs_t mLastEventTime;
Lloyd Piquee83f9312018-02-01 12:53:17 -0800225 DispSync::Callback* mCallback;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700226 };
227
228 struct CallbackInvocation {
Lloyd Piquee83f9312018-02-01 12:53:17 -0800229 DispSync::Callback* mCallback;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700230 nsecs_t mEventTime;
231 };
232
233 nsecs_t computeNextEventTimeLocked(nsecs_t now) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000234 if (kTraceDetailedInfo) ATRACE_CALL();
235 ALOGV("[%s] computeNextEventTimeLocked", mName);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700236 nsecs_t nextEventTime = INT64_MAX;
237 for (size_t i = 0; i < mEventListeners.size(); i++) {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800238 nsecs_t t = computeListenerNextEventTimeLocked(mEventListeners[i], now);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700239
240 if (t < nextEventTime) {
241 nextEventTime = t;
242 }
243 }
244
Tim Murray4a4e4a22016-04-19 16:29:23 +0000245 ALOGV("[%s] nextEventTime = %" PRId64, mName, ns2us(nextEventTime));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700246 return nextEventTime;
247 }
248
249 Vector<CallbackInvocation> gatherCallbackInvocationsLocked(nsecs_t now) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000250 if (kTraceDetailedInfo) ATRACE_CALL();
Lloyd Pique78ce4182018-01-31 16:39:51 -0800251 ALOGV("[%s] gatherCallbackInvocationsLocked @ %" PRId64, mName, ns2us(now));
Tim Murray4a4e4a22016-04-19 16:29:23 +0000252
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700253 Vector<CallbackInvocation> callbackInvocations;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000254 nsecs_t onePeriodAgo = now - mPeriod;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700255
256 for (size_t i = 0; i < mEventListeners.size(); i++) {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800257 nsecs_t t = computeListenerNextEventTimeLocked(mEventListeners[i], onePeriodAgo);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700258
Jamie Gennis0d5c60e2013-10-09 17:49:37 -0700259 if (t < now) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700260 CallbackInvocation ci;
261 ci.mCallback = mEventListeners[i].mCallback;
262 ci.mEventTime = t;
Lloyd Pique78ce4182018-01-31 16:39:51 -0800263 ALOGV("[%s] [%s] Preparing to fire", mName, mEventListeners[i].mName);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700264 callbackInvocations.push(ci);
265 mEventListeners.editItemAt(i).mLastEventTime = t;
266 }
267 }
268
269 return callbackInvocations;
270 }
271
Lloyd Pique78ce4182018-01-31 16:39:51 -0800272 nsecs_t computeListenerNextEventTimeLocked(const EventListener& listener, nsecs_t baseTime) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000273 if (kTraceDetailedInfo) ATRACE_CALL();
Lloyd Pique78ce4182018-01-31 16:39:51 -0800274 ALOGV("[%s] [%s] computeListenerNextEventTimeLocked(%" PRId64 ")", mName, listener.mName,
275 ns2us(baseTime));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700276
Tim Murray4a4e4a22016-04-19 16:29:23 +0000277 nsecs_t lastEventTime = listener.mLastEventTime + mWakeupLatency;
278 ALOGV("[%s] lastEventTime: %" PRId64, mName, ns2us(lastEventTime));
279 if (baseTime < lastEventTime) {
280 baseTime = lastEventTime;
Lloyd Pique78ce4182018-01-31 16:39:51 -0800281 ALOGV("[%s] Clamping baseTime to lastEventTime -> %" PRId64, mName, ns2us(baseTime));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700282 }
283
Tim Murray4a4e4a22016-04-19 16:29:23 +0000284 baseTime -= mReferenceTime;
285 ALOGV("[%s] Relative baseTime = %" PRId64, mName, ns2us(baseTime));
286 nsecs_t phase = mPhase + listener.mPhase;
287 ALOGV("[%s] Phase = %" PRId64, mName, ns2us(phase));
288 baseTime -= phase;
289 ALOGV("[%s] baseTime - phase = %" PRId64, mName, ns2us(baseTime));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700290
Tim Murray4a4e4a22016-04-19 16:29:23 +0000291 // If our previous time is before the reference (because the reference
292 // has since been updated), the division by mPeriod will truncate
293 // towards zero instead of computing the floor. Since in all cases
294 // before the reference we want the next time to be effectively now, we
295 // set baseTime to -mPeriod so that numPeriods will be -1.
296 // When we add 1 and the phase, we will be at the correct event time for
297 // this period.
298 if (baseTime < 0) {
299 ALOGV("[%s] Correcting negative baseTime", mName);
300 baseTime = -mPeriod;
301 }
302
303 nsecs_t numPeriods = baseTime / mPeriod;
304 ALOGV("[%s] numPeriods = %" PRId64, mName, numPeriods);
305 nsecs_t t = (numPeriods + 1) * mPeriod + phase;
306 ALOGV("[%s] t = %" PRId64, mName, ns2us(t));
307 t += mReferenceTime;
308 ALOGV("[%s] Absolute t = %" PRId64, mName, ns2us(t));
309
310 // Check that it's been slightly more than half a period since the last
311 // event so that we don't accidentally fall into double-rate vsyncs
312 if (t - listener.mLastEventTime < (3 * mPeriod / 5)) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700313 t += mPeriod;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000314 ALOGV("[%s] Modifying t -> %" PRId64, mName, ns2us(t));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700315 }
316
Tim Murray4a4e4a22016-04-19 16:29:23 +0000317 t -= mWakeupLatency;
318 ALOGV("[%s] Corrected for wakeup latency -> %" PRId64, mName, ns2us(t));
319
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700320 return t;
321 }
322
323 void fireCallbackInvocations(const Vector<CallbackInvocation>& callbacks) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000324 if (kTraceDetailedInfo) ATRACE_CALL();
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700325 for (size_t i = 0; i < callbacks.size(); i++) {
326 callbacks[i].mCallback->onDispSyncEvent(callbacks[i].mEventTime);
327 }
328 }
329
Tim Murray4a4e4a22016-04-19 16:29:23 +0000330 const char* const mName;
331
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700332 bool mStop;
333
334 nsecs_t mPeriod;
335 nsecs_t mPhase;
Haixia Shi676b1f62015-10-28 16:19:01 -0700336 nsecs_t mReferenceTime;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700337 nsecs_t mWakeupLatency;
338
Tim Murray4a4e4a22016-04-19 16:29:23 +0000339 int64_t mFrameNumber;
340
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700341 Vector<EventListener> mEventListeners;
342
343 Mutex mMutex;
344 Condition mCond;
345};
346
Tim Murray4a4e4a22016-04-19 16:29:23 +0000347#undef LOG_TAG
348#define LOG_TAG "DispSync"
349
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700350class ZeroPhaseTracer : public DispSync::Callback {
351public:
352 ZeroPhaseTracer() : mParity(false) {}
353
Mark Salyzyn92dc3fc2014-03-12 13:12:44 -0700354 virtual void onDispSyncEvent(nsecs_t /*when*/) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700355 mParity = !mParity;
356 ATRACE_INT("ZERO_PHASE_VSYNC", mParity ? 1 : 0);
357 }
358
359private:
360 bool mParity;
361};
362
Lloyd Pique78ce4182018-01-31 16:39:51 -0800363DispSync::DispSync(const char* name)
364 : mName(name), mRefreshSkipCount(0), mThread(new DispSyncThread(name)) {}
Andy McFadden645b1f72014-06-10 14:43:32 -0700365
Saurabh Shahf4174532017-07-13 10:45:07 -0700366DispSync::~DispSync() {}
367
368void DispSync::init(bool hasSyncFramework, int64_t dispSyncPresentTimeOffset) {
369 mIgnorePresentFences = !hasSyncFramework;
370 mPresentTimeOffset = dispSyncPresentTimeOffset;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700371 mThread->run("DispSync", PRIORITY_URGENT_DISPLAY + PRIORITY_MORE_FAVORABLE);
Saurabh Shahf4174532017-07-13 10:45:07 -0700372
Tim Murrayacff43d2016-07-29 13:57:24 -0700373 // set DispSync to SCHED_FIFO to minimize jitter
374 struct sched_param param = {0};
Tim Murray35520632016-09-07 12:18:17 -0700375 param.sched_priority = 2;
Tim Murrayacff43d2016-07-29 13:57:24 -0700376 if (sched_setscheduler(mThread->getTid(), SCHED_FIFO, &param) != 0) {
377 ALOGE("Couldn't set SCHED_FIFO for DispSyncThread");
378 }
379
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700380 reset();
381 beginResync();
382
Andy McFadden5167ec62014-05-22 13:08:43 -0700383 if (kTraceDetailedInfo) {
384 // If we're not getting present fences then the ZeroPhaseTracer
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700385 // would prevent HW vsync event from ever being turned off.
Andy McFadden5167ec62014-05-22 13:08:43 -0700386 // Even if we're just ignoring the fences, the zero-phase tracing is
387 // not needed because any time there is an event registered we will
388 // turn on the HW vsync events.
Fabien Sanglardcbf153b2017-03-10 17:57:12 -0800389 if (!mIgnorePresentFences && kEnableZeroPhaseTracer) {
Lloyd Piquee83f9312018-02-01 12:53:17 -0800390 mZeroPhaseTracer = std::make_unique<ZeroPhaseTracer>();
391 addEventListener("ZeroPhaseTracer", 0, mZeroPhaseTracer.get());
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700392 }
393 }
394}
395
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700396void DispSync::reset() {
397 Mutex::Autolock lock(mMutex);
398
Haixia Shi676b1f62015-10-28 16:19:01 -0700399 mPhase = 0;
400 mReferenceTime = 0;
401 mModelUpdated = false;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700402 mNumResyncSamples = 0;
403 mFirstResyncSample = 0;
404 mNumResyncSamplesSincePresent = 0;
405 resetErrorLocked();
406}
407
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700408bool DispSync::addPresentFence(const std::shared_ptr<FenceTime>& fenceTime) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700409 Mutex::Autolock lock(mMutex);
410
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700411 mPresentFences[mPresentSampleOffset] = fenceTime;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700412 mPresentSampleOffset = (mPresentSampleOffset + 1) % NUM_PRESENT_SAMPLES;
413 mNumResyncSamplesSincePresent = 0;
414
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700415 updateErrorLocked();
416
Haixia Shi676b1f62015-10-28 16:19:01 -0700417 return !mModelUpdated || mError > kErrorThreshold;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700418}
419
420void DispSync::beginResync() {
421 Mutex::Autolock lock(mMutex);
Tim Murray4a4e4a22016-04-19 16:29:23 +0000422 ALOGV("[%s] beginResync", mName);
Haixia Shi676b1f62015-10-28 16:19:01 -0700423 mModelUpdated = false;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700424 mNumResyncSamples = 0;
425}
426
427bool DispSync::addResyncSample(nsecs_t timestamp) {
428 Mutex::Autolock lock(mMutex);
429
Tim Murray4a4e4a22016-04-19 16:29:23 +0000430 ALOGV("[%s] addResyncSample(%" PRId64 ")", mName, ns2us(timestamp));
431
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700432 size_t idx = (mFirstResyncSample + mNumResyncSamples) % MAX_RESYNC_SAMPLES;
433 mResyncSamples[idx] = timestamp;
Haixia Shi664339a2015-10-28 13:22:22 -0700434 if (mNumResyncSamples == 0) {
Haixia Shi676b1f62015-10-28 16:19:01 -0700435 mPhase = 0;
436 mReferenceTime = timestamp;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000437 ALOGV("[%s] First resync sample: mPeriod = %" PRId64 ", mPhase = 0, "
Lloyd Pique78ce4182018-01-31 16:39:51 -0800438 "mReferenceTime = %" PRId64,
439 mName, ns2us(mPeriod), ns2us(mReferenceTime));
Tim Murray4a4e4a22016-04-19 16:29:23 +0000440 mThread->updateModel(mPeriod, mPhase, mReferenceTime);
Haixia Shi664339a2015-10-28 13:22:22 -0700441 }
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700442
443 if (mNumResyncSamples < MAX_RESYNC_SAMPLES) {
444 mNumResyncSamples++;
445 } else {
446 mFirstResyncSample = (mFirstResyncSample + 1) % MAX_RESYNC_SAMPLES;
447 }
448
449 updateModelLocked();
450
451 if (mNumResyncSamplesSincePresent++ > MAX_RESYNC_SAMPLES_WITHOUT_PRESENT) {
452 resetErrorLocked();
453 }
454
Fabien Sanglardcbf153b2017-03-10 17:57:12 -0800455 if (mIgnorePresentFences) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700456 // If we don't have the sync framework we will never have
457 // addPresentFence called. This means we have no way to know whether
458 // or not we're synchronized with the HW vsyncs, so we just request
459 // that the HW vsync events be turned on whenever we need to generate
460 // SW vsync events.
461 return mThread->hasAnyEventListeners();
462 }
463
Tim Murray4a4e4a22016-04-19 16:29:23 +0000464 // Check against kErrorThreshold / 2 to add some hysteresis before having to
465 // resync again
466 bool modelLocked = mModelUpdated && mError < (kErrorThreshold / 2);
Lloyd Pique78ce4182018-01-31 16:39:51 -0800467 ALOGV("[%s] addResyncSample returning %s", mName, modelLocked ? "locked" : "unlocked");
Tim Murray4a4e4a22016-04-19 16:29:23 +0000468 return !modelLocked;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700469}
470
Lloyd Pique78ce4182018-01-31 16:39:51 -0800471void DispSync::endResync() {}
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700472
Lloyd Piquee83f9312018-02-01 12:53:17 -0800473status_t DispSync::addEventListener(const char* name, nsecs_t phase, Callback* callback) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700474 Mutex::Autolock lock(mMutex);
Tim Murray4a4e4a22016-04-19 16:29:23 +0000475 return mThread->addEventListener(name, phase, callback);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700476}
477
Andy McFadden645b1f72014-06-10 14:43:32 -0700478void DispSync::setRefreshSkipCount(int count) {
479 Mutex::Autolock lock(mMutex);
480 ALOGD("setRefreshSkipCount(%d)", count);
481 mRefreshSkipCount = count;
482 updateModelLocked();
Ruchi Kandoif52b3c82014-04-24 16:42:35 -0700483}
484
Lloyd Piquee83f9312018-02-01 12:53:17 -0800485status_t DispSync::removeEventListener(Callback* callback) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700486 Mutex::Autolock lock(mMutex);
487 return mThread->removeEventListener(callback);
488}
489
490void DispSync::setPeriod(nsecs_t period) {
491 Mutex::Autolock lock(mMutex);
492 mPeriod = period;
493 mPhase = 0;
Haixia Shi676b1f62015-10-28 16:19:01 -0700494 mReferenceTime = 0;
495 mThread->updateModel(mPeriod, mPhase, mReferenceTime);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700496}
497
Lajos Molnar67d8bd62014-09-11 14:58:45 -0700498nsecs_t DispSync::getPeriod() {
499 // lock mutex as mPeriod changes multiple times in updateModelLocked
500 Mutex::Autolock lock(mMutex);
501 return mPeriod;
502}
503
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700504void DispSync::updateModelLocked() {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000505 ALOGV("[%s] updateModelLocked %zu", mName, mNumResyncSamples);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700506 if (mNumResyncSamples >= MIN_RESYNC_SAMPLES_FOR_UPDATE) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000507 ALOGV("[%s] Computing...", mName);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700508 nsecs_t durationSum = 0;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000509 nsecs_t minDuration = INT64_MAX;
510 nsecs_t maxDuration = 0;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700511 for (size_t i = 1; i < mNumResyncSamples; i++) {
512 size_t idx = (mFirstResyncSample + i) % MAX_RESYNC_SAMPLES;
513 size_t prev = (idx + MAX_RESYNC_SAMPLES - 1) % MAX_RESYNC_SAMPLES;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000514 nsecs_t duration = mResyncSamples[idx] - mResyncSamples[prev];
515 durationSum += duration;
516 minDuration = min(minDuration, duration);
517 maxDuration = max(maxDuration, duration);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700518 }
519
Tim Murray4a4e4a22016-04-19 16:29:23 +0000520 // Exclude the min and max from the average
521 durationSum -= minDuration + maxDuration;
522 mPeriod = durationSum / (mNumResyncSamples - 3);
523
524 ALOGV("[%s] mPeriod = %" PRId64, mName, ns2us(mPeriod));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700525
526 double sampleAvgX = 0;
527 double sampleAvgY = 0;
528 double scale = 2.0 * M_PI / double(mPeriod);
Tim Murray4a4e4a22016-04-19 16:29:23 +0000529 // Intentionally skip the first sample
530 for (size_t i = 1; i < mNumResyncSamples; i++) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700531 size_t idx = (mFirstResyncSample + i) % MAX_RESYNC_SAMPLES;
Haixia Shi676b1f62015-10-28 16:19:01 -0700532 nsecs_t sample = mResyncSamples[idx] - mReferenceTime;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700533 double samplePhase = double(sample % mPeriod) * scale;
534 sampleAvgX += cos(samplePhase);
535 sampleAvgY += sin(samplePhase);
536 }
537
Tim Murray4a4e4a22016-04-19 16:29:23 +0000538 sampleAvgX /= double(mNumResyncSamples - 1);
539 sampleAvgY /= double(mNumResyncSamples - 1);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700540
541 mPhase = nsecs_t(atan2(sampleAvgY, sampleAvgX) / scale);
542
Tim Murray4a4e4a22016-04-19 16:29:23 +0000543 ALOGV("[%s] mPhase = %" PRId64, mName, ns2us(mPhase));
544
545 if (mPhase < -(mPeriod / 2)) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700546 mPhase += mPeriod;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000547 ALOGV("[%s] Adjusting mPhase -> %" PRId64, mName, ns2us(mPhase));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700548 }
549
Andy McFadden5167ec62014-05-22 13:08:43 -0700550 if (kTraceDetailedInfo) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700551 ATRACE_INT64("DispSync:Period", mPeriod);
Tim Murray4a4e4a22016-04-19 16:29:23 +0000552 ATRACE_INT64("DispSync:Phase", mPhase + mPeriod / 2);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700553 }
554
Andy McFadden645b1f72014-06-10 14:43:32 -0700555 // Artificially inflate the period if requested.
556 mPeriod += mPeriod * mRefreshSkipCount;
557
Haixia Shi676b1f62015-10-28 16:19:01 -0700558 mThread->updateModel(mPeriod, mPhase, mReferenceTime);
559 mModelUpdated = true;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700560 }
561}
562
563void DispSync::updateErrorLocked() {
Haixia Shi676b1f62015-10-28 16:19:01 -0700564 if (!mModelUpdated) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700565 return;
566 }
567
Andy McFadden645b1f72014-06-10 14:43:32 -0700568 // Need to compare present fences against the un-adjusted refresh period,
569 // since they might arrive between two events.
570 nsecs_t period = mPeriod / (1 + mRefreshSkipCount);
571
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700572 int numErrSamples = 0;
573 nsecs_t sqErrSum = 0;
574
575 for (size_t i = 0; i < NUM_PRESENT_SAMPLES; i++) {
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700576 // Only check for the cached value of signal time to avoid unecessary
577 // syscalls. It is the responsibility of the DispSync owner to
578 // call getSignalTime() periodically so the cache is updated when the
579 // fence signals.
580 nsecs_t time = mPresentFences[i]->getCachedSignalTime();
Lloyd Pique78ce4182018-01-31 16:39:51 -0800581 if (time == Fence::SIGNAL_TIME_PENDING || time == Fence::SIGNAL_TIME_INVALID) {
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700582 continue;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700583 }
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700584
585 nsecs_t sample = time - mReferenceTime;
586 if (sample <= mPhase) {
587 continue;
588 }
589
590 nsecs_t sampleErr = (sample - mPhase) % period;
591 if (sampleErr > period / 2) {
592 sampleErr -= period;
593 }
594 sqErrSum += sampleErr * sampleErr;
595 numErrSamples++;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700596 }
597
598 if (numErrSamples > 0) {
599 mError = sqErrSum / numErrSamples;
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700600 mZeroErrSamplesCount = 0;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700601 } else {
602 mError = 0;
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700603 // Use mod ACCEPTABLE_ZERO_ERR_SAMPLES_COUNT to avoid log spam.
604 mZeroErrSamplesCount++;
Lloyd Pique78ce4182018-01-31 16:39:51 -0800605 ALOGE_IF((mZeroErrSamplesCount % ACCEPTABLE_ZERO_ERR_SAMPLES_COUNT) == 0,
606 "No present times for model error.");
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700607 }
608
Andy McFadden5167ec62014-05-22 13:08:43 -0700609 if (kTraceDetailedInfo) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700610 ATRACE_INT64("DispSync:Error", mError);
611 }
612}
613
614void DispSync::resetErrorLocked() {
615 mPresentSampleOffset = 0;
616 mError = 0;
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700617 mZeroErrSamplesCount = 0;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700618 for (size_t i = 0; i < NUM_PRESENT_SAMPLES; i++) {
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700619 mPresentFences[i] = FenceTime::NO_FENCE;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700620 }
621}
622
Andy McFadden41d67d72014-04-25 16:58:34 -0700623nsecs_t DispSync::computeNextRefresh(int periodOffset) const {
Andy McFadden150ecd82014-05-08 14:56:50 -0700624 Mutex::Autolock lock(mMutex);
Andy McFadden41d67d72014-04-25 16:58:34 -0700625 nsecs_t now = systemTime(SYSTEM_TIME_MONOTONIC);
Haixia Shi676b1f62015-10-28 16:19:01 -0700626 nsecs_t phase = mReferenceTime + mPhase;
627 return (((now - phase) / mPeriod) + periodOffset + 1) * mPeriod + phase;
Andy McFadden41d67d72014-04-25 16:58:34 -0700628}
629
Andy McFaddenc751e922014-05-08 14:53:26 -0700630void DispSync::dump(String8& result) const {
631 Mutex::Autolock lock(mMutex);
Lloyd Pique78ce4182018-01-31 16:39:51 -0800632 result.appendFormat("present fences are %s\n", mIgnorePresentFences ? "ignored" : "used");
633 result.appendFormat("mPeriod: %" PRId64 " ns (%.3f fps; skipCount=%d)\n", mPeriod,
634 1000000000.0 / mPeriod, mRefreshSkipCount);
Andy McFadden5167ec62014-05-22 13:08:43 -0700635 result.appendFormat("mPhase: %" PRId64 " ns\n", mPhase);
Lloyd Pique78ce4182018-01-31 16:39:51 -0800636 result.appendFormat("mError: %" PRId64 " ns (sqrt=%.1f)\n", mError, sqrt(mError));
Andy McFadden5167ec62014-05-22 13:08:43 -0700637 result.appendFormat("mNumResyncSamplesSincePresent: %d (limit %d)\n",
Lloyd Pique78ce4182018-01-31 16:39:51 -0800638 mNumResyncSamplesSincePresent, MAX_RESYNC_SAMPLES_WITHOUT_PRESENT);
639 result.appendFormat("mNumResyncSamples: %zd (max %d)\n", mNumResyncSamples, MAX_RESYNC_SAMPLES);
Andy McFaddenc751e922014-05-08 14:53:26 -0700640
641 result.appendFormat("mResyncSamples:\n");
642 nsecs_t previous = -1;
643 for (size_t i = 0; i < mNumResyncSamples; i++) {
644 size_t idx = (mFirstResyncSample + i) % MAX_RESYNC_SAMPLES;
645 nsecs_t sampleTime = mResyncSamples[idx];
646 if (i == 0) {
Andy McFadden5167ec62014-05-22 13:08:43 -0700647 result.appendFormat(" %" PRId64 "\n", sampleTime);
Andy McFaddenc751e922014-05-08 14:53:26 -0700648 } else {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800649 result.appendFormat(" %" PRId64 " (+%" PRId64 ")\n", sampleTime,
650 sampleTime - previous);
Andy McFaddenc751e922014-05-08 14:53:26 -0700651 }
652 previous = sampleTime;
653 }
654
Lloyd Pique78ce4182018-01-31 16:39:51 -0800655 result.appendFormat("mPresentFences [%d]:\n", NUM_PRESENT_SAMPLES);
Andy McFadden5167ec62014-05-22 13:08:43 -0700656 nsecs_t now = systemTime(SYSTEM_TIME_MONOTONIC);
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700657 previous = Fence::SIGNAL_TIME_INVALID;
Andy McFaddenc751e922014-05-08 14:53:26 -0700658 for (size_t i = 0; i < NUM_PRESENT_SAMPLES; i++) {
659 size_t idx = (i + mPresentSampleOffset) % NUM_PRESENT_SAMPLES;
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700660 nsecs_t presentTime = mPresentFences[idx]->getSignalTime();
661 if (presentTime == Fence::SIGNAL_TIME_PENDING) {
Andy McFaddenc751e922014-05-08 14:53:26 -0700662 result.appendFormat(" [unsignaled fence]\n");
Lloyd Pique78ce4182018-01-31 16:39:51 -0800663 } else if (presentTime == Fence::SIGNAL_TIME_INVALID) {
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700664 result.appendFormat(" [invalid fence]\n");
665 } else if (previous == Fence::SIGNAL_TIME_PENDING ||
Lloyd Pique78ce4182018-01-31 16:39:51 -0800666 previous == Fence::SIGNAL_TIME_INVALID) {
Andy McFadden5167ec62014-05-22 13:08:43 -0700667 result.appendFormat(" %" PRId64 " (%.3f ms ago)\n", presentTime,
Lloyd Pique78ce4182018-01-31 16:39:51 -0800668 (now - presentTime) / 1000000.0);
Andy McFaddenc751e922014-05-08 14:53:26 -0700669 } else {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800670 result.appendFormat(" %" PRId64 " (+%" PRId64 " / %.3f) (%.3f ms ago)\n", presentTime,
671 presentTime - previous, (presentTime - previous) / (double)mPeriod,
672 (now - presentTime) / 1000000.0);
Andy McFaddenc751e922014-05-08 14:53:26 -0700673 }
674 previous = presentTime;
675 }
Andy McFadden5167ec62014-05-22 13:08:43 -0700676
677 result.appendFormat("current monotonic time: %" PRId64 "\n", now);
Andy McFaddenc751e922014-05-08 14:53:26 -0700678}
679
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700680} // namespace android