blob: 54a1b51c359bbd7e005048c0c6292e89040c1fa1 [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>
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070031
Brian Andersonfbc80ae2017-05-26 16:23:54 -070032#include <ui/FenceTime.h>
Mark Salyzyna5e161b2016-09-29 08:08:05 -070033
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070034#include "DispSync.h"
35#include "EventLog/EventLog.h"
Lloyd Pique78ce4182018-01-31 16:39:51 -080036#include "SurfaceFlinger.h"
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070037
Tim Murray4a4e4a22016-04-19 16:29:23 +000038using std::max;
39using std::min;
40
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070041namespace android {
42
Lloyd Pique41be5d22018-06-21 13:11:48 -070043DispSync::~DispSync() = default;
44
45namespace impl {
46
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070047// Setting this to true enables verbose tracing that can be used to debug
48// vsync event model or phase issues.
Andy McFadden5167ec62014-05-22 13:08:43 -070049static const bool kTraceDetailedInfo = false;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070050
Tim Murray4a4e4a22016-04-19 16:29:23 +000051// Setting this to true adds a zero-phase tracer for correlating with hardware
52// vsync events
53static const bool kEnableZeroPhaseTracer = false;
54
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070055// This is the threshold used to determine when hardware vsync events are
56// needed to re-synchronize the software vsync model with the hardware. The
57// error metric used is the mean of the squared difference between each
58// present time and the nearest software-predicted vsync.
Lloyd Pique78ce4182018-01-31 16:39:51 -080059static const nsecs_t kErrorThreshold = 160000000000; // 400 usec squared
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070060
Tim Murray4a4e4a22016-04-19 16:29:23 +000061#undef LOG_TAG
62#define LOG_TAG "DispSyncThread"
Lloyd Pique78ce4182018-01-31 16:39:51 -080063class DispSyncThread : public Thread {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070064public:
Lloyd Pique78ce4182018-01-31 16:39:51 -080065 explicit DispSyncThread(const char* name)
66 : mName(name),
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070067 mStop(false),
68 mPeriod(0),
69 mPhase(0),
Haixia Shi676b1f62015-10-28 16:19:01 -070070 mReferenceTime(0),
Tim Murray4a4e4a22016-04-19 16:29:23 +000071 mWakeupLatency(0),
72 mFrameNumber(0) {}
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070073
74 virtual ~DispSyncThread() {}
75
Haixia Shi676b1f62015-10-28 16:19:01 -070076 void updateModel(nsecs_t period, nsecs_t phase, nsecs_t referenceTime) {
Tim Murray4a4e4a22016-04-19 16:29:23 +000077 if (kTraceDetailedInfo) ATRACE_CALL();
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070078 Mutex::Autolock lock(mMutex);
79 mPeriod = period;
80 mPhase = phase;
Haixia Shi676b1f62015-10-28 16:19:01 -070081 mReferenceTime = referenceTime;
Tim Murray4a4e4a22016-04-19 16:29:23 +000082 ALOGV("[%s] updateModel: mPeriod = %" PRId64 ", mPhase = %" PRId64
Lloyd Pique78ce4182018-01-31 16:39:51 -080083 " mReferenceTime = %" PRId64,
84 mName, ns2us(mPeriod), ns2us(mPhase), ns2us(mReferenceTime));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070085 mCond.signal();
86 }
87
88 void stop() {
Tim Murray4a4e4a22016-04-19 16:29:23 +000089 if (kTraceDetailedInfo) ATRACE_CALL();
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070090 Mutex::Autolock lock(mMutex);
91 mStop = true;
92 mCond.signal();
93 }
94
95 virtual bool threadLoop() {
96 status_t err;
97 nsecs_t now = systemTime(SYSTEM_TIME_MONOTONIC);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -070098
99 while (true) {
Ana Krulec9a52b192018-07-12 18:18:47 -0400100 std::vector<CallbackInvocation> callbackInvocations;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700101
102 nsecs_t targetTime = 0;
103
104 { // Scope for lock
105 Mutex::Autolock lock(mMutex);
106
Tim Murray4a4e4a22016-04-19 16:29:23 +0000107 if (kTraceDetailedInfo) {
108 ATRACE_INT64("DispSync:Frame", mFrameNumber);
109 }
110 ALOGV("[%s] Frame %" PRId64, mName, mFrameNumber);
111 ++mFrameNumber;
112
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700113 if (mStop) {
114 return false;
115 }
116
117 if (mPeriod == 0) {
118 err = mCond.wait(mMutex);
119 if (err != NO_ERROR) {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800120 ALOGE("error waiting for new events: %s (%d)", strerror(-err), err);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700121 return false;
122 }
123 continue;
124 }
125
Dan Stoza8f8374d2016-04-19 10:03:46 -0700126 targetTime = computeNextEventTimeLocked(now);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700127
128 bool isWakeup = false;
129
130 if (now < targetTime) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000131 if (kTraceDetailedInfo) ATRACE_NAME("DispSync waiting");
Dan Stoza8f8374d2016-04-19 10:03:46 -0700132
133 if (targetTime == INT64_MAX) {
134 ALOGV("[%s] Waiting forever", mName);
135 err = mCond.wait(mMutex);
136 } else {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800137 ALOGV("[%s] Waiting until %" PRId64, mName, ns2us(targetTime));
Dan Stoza8f8374d2016-04-19 10:03:46 -0700138 err = mCond.waitRelative(mMutex, targetTime - now);
139 }
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700140
141 if (err == TIMED_OUT) {
142 isWakeup = true;
143 } else if (err != NO_ERROR) {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800144 ALOGE("error waiting for next event: %s (%d)", strerror(-err), err);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700145 return false;
146 }
147 }
148
149 now = systemTime(SYSTEM_TIME_MONOTONIC);
150
Tim Murray4a4e4a22016-04-19 16:29:23 +0000151 // Don't correct by more than 1.5 ms
152 static const nsecs_t kMaxWakeupLatency = us2ns(1500);
153
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700154 if (isWakeup) {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800155 mWakeupLatency = ((mWakeupLatency * 63) + (now - targetTime)) / 64;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000156 mWakeupLatency = min(mWakeupLatency, kMaxWakeupLatency);
Andy McFadden5167ec62014-05-22 13:08:43 -0700157 if (kTraceDetailedInfo) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000158 ATRACE_INT64("DispSync:WakeupLat", now - targetTime);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700159 ATRACE_INT64("DispSync:AvgWakeupLat", mWakeupLatency);
160 }
161 }
162
163 callbackInvocations = gatherCallbackInvocationsLocked(now);
164 }
165
166 if (callbackInvocations.size() > 0) {
Andy McFadden645b1f72014-06-10 14:43:32 -0700167 fireCallbackInvocations(callbackInvocations);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700168 }
169 }
170
171 return false;
172 }
173
Lloyd Piquee83f9312018-02-01 12:53:17 -0800174 status_t addEventListener(const char* name, nsecs_t phase, DispSync::Callback* callback) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000175 if (kTraceDetailedInfo) ATRACE_CALL();
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700176 Mutex::Autolock lock(mMutex);
177
178 for (size_t i = 0; i < mEventListeners.size(); i++) {
179 if (mEventListeners[i].mCallback == callback) {
180 return BAD_VALUE;
181 }
182 }
183
184 EventListener listener;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000185 listener.mName = name;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700186 listener.mPhase = phase;
187 listener.mCallback = callback;
Jamie Gennis629b9872013-10-29 13:36:12 -0700188
189 // We want to allow the firstmost future event to fire without
Tim Murray4a4e4a22016-04-19 16:29:23 +0000190 // allowing any past events to fire
Lloyd Pique78ce4182018-01-31 16:39:51 -0800191 listener.mLastEventTime = systemTime() - mPeriod / 2 + mPhase - mWakeupLatency;
Jamie Gennis629b9872013-10-29 13:36:12 -0700192
Ana Krulec9a52b192018-07-12 18:18:47 -0400193 mEventListeners.push_back(listener);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700194
195 mCond.signal();
196
197 return NO_ERROR;
198 }
199
Lloyd Piquee83f9312018-02-01 12:53:17 -0800200 status_t removeEventListener(DispSync::Callback* callback) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000201 if (kTraceDetailedInfo) ATRACE_CALL();
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700202 Mutex::Autolock lock(mMutex);
203
Ana Krulec9a52b192018-07-12 18:18:47 -0400204 for (std::vector<EventListener>::iterator it = mEventListeners.begin();
205 it != mEventListeners.end(); ++it) {
206 if (it->mCallback == callback) {
207 mEventListeners.erase(it);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700208 mCond.signal();
209 return NO_ERROR;
210 }
211 }
212
213 return BAD_VALUE;
214 }
215
Dan Stoza84d619e2018-03-28 17:07:36 -0700216 status_t changePhaseOffset(DispSync::Callback* callback, nsecs_t phase) {
217 if (kTraceDetailedInfo) ATRACE_CALL();
218 Mutex::Autolock lock(mMutex);
219
Ana Krulec9a52b192018-07-12 18:18:47 -0400220 for (auto& eventListener : mEventListeners) {
221 if (eventListener.mCallback == callback) {
222 const nsecs_t oldPhase = eventListener.mPhase;
223 eventListener.mPhase = phase;
Dan Stoza84d619e2018-03-28 17:07:36 -0700224
225 // Pretend that the last time this event was handled at the same frame but with the
226 // new offset to allow for a seamless offset change without double-firing or
227 // skipping.
Jorim Jaggi22ec38b2018-06-19 15:57:08 +0200228 nsecs_t diff = oldPhase - phase;
229 if (diff > mPeriod / 2) {
230 diff -= mPeriod;
231 } else if (diff < -mPeriod / 2) {
232 diff += mPeriod;
233 }
Ana Krulec9a52b192018-07-12 18:18:47 -0400234 eventListener.mLastEventTime -= diff;
Dan Stoza84d619e2018-03-28 17:07:36 -0700235 mCond.signal();
236 return NO_ERROR;
237 }
238 }
239
240 return BAD_VALUE;
241 }
242
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700243private:
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700244 struct EventListener {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000245 const char* mName;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700246 nsecs_t mPhase;
247 nsecs_t mLastEventTime;
Lloyd Piquee83f9312018-02-01 12:53:17 -0800248 DispSync::Callback* mCallback;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700249 };
250
251 struct CallbackInvocation {
Lloyd Piquee83f9312018-02-01 12:53:17 -0800252 DispSync::Callback* mCallback;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700253 nsecs_t mEventTime;
254 };
255
256 nsecs_t computeNextEventTimeLocked(nsecs_t now) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000257 if (kTraceDetailedInfo) ATRACE_CALL();
258 ALOGV("[%s] computeNextEventTimeLocked", mName);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700259 nsecs_t nextEventTime = INT64_MAX;
260 for (size_t i = 0; i < mEventListeners.size(); i++) {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800261 nsecs_t t = computeListenerNextEventTimeLocked(mEventListeners[i], now);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700262
263 if (t < nextEventTime) {
264 nextEventTime = t;
265 }
266 }
267
Tim Murray4a4e4a22016-04-19 16:29:23 +0000268 ALOGV("[%s] nextEventTime = %" PRId64, mName, ns2us(nextEventTime));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700269 return nextEventTime;
270 }
271
Ana Krulec9a52b192018-07-12 18:18:47 -0400272 std::vector<CallbackInvocation> gatherCallbackInvocationsLocked(nsecs_t now) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000273 if (kTraceDetailedInfo) ATRACE_CALL();
Lloyd Pique78ce4182018-01-31 16:39:51 -0800274 ALOGV("[%s] gatherCallbackInvocationsLocked @ %" PRId64, mName, ns2us(now));
Tim Murray4a4e4a22016-04-19 16:29:23 +0000275
Ana Krulec9a52b192018-07-12 18:18:47 -0400276 std::vector<CallbackInvocation> callbackInvocations;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000277 nsecs_t onePeriodAgo = now - mPeriod;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700278
Ana Krulec9a52b192018-07-12 18:18:47 -0400279 for (auto& eventListener : mEventListeners) {
280 nsecs_t t = computeListenerNextEventTimeLocked(eventListener, onePeriodAgo);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700281
Jamie Gennis0d5c60e2013-10-09 17:49:37 -0700282 if (t < now) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700283 CallbackInvocation ci;
Ana Krulec9a52b192018-07-12 18:18:47 -0400284 ci.mCallback = eventListener.mCallback;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700285 ci.mEventTime = t;
Ana Krulec9a52b192018-07-12 18:18:47 -0400286 ALOGV("[%s] [%s] Preparing to fire", mName, eventListener.mName);
287 callbackInvocations.push_back(ci);
288 eventListener.mLastEventTime = t;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700289 }
290 }
291
292 return callbackInvocations;
293 }
294
Lloyd Pique78ce4182018-01-31 16:39:51 -0800295 nsecs_t computeListenerNextEventTimeLocked(const EventListener& listener, nsecs_t baseTime) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000296 if (kTraceDetailedInfo) ATRACE_CALL();
Lloyd Pique78ce4182018-01-31 16:39:51 -0800297 ALOGV("[%s] [%s] computeListenerNextEventTimeLocked(%" PRId64 ")", mName, listener.mName,
298 ns2us(baseTime));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700299
Tim Murray4a4e4a22016-04-19 16:29:23 +0000300 nsecs_t lastEventTime = listener.mLastEventTime + mWakeupLatency;
301 ALOGV("[%s] lastEventTime: %" PRId64, mName, ns2us(lastEventTime));
302 if (baseTime < lastEventTime) {
303 baseTime = lastEventTime;
Lloyd Pique78ce4182018-01-31 16:39:51 -0800304 ALOGV("[%s] Clamping baseTime to lastEventTime -> %" PRId64, mName, ns2us(baseTime));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700305 }
306
Tim Murray4a4e4a22016-04-19 16:29:23 +0000307 baseTime -= mReferenceTime;
308 ALOGV("[%s] Relative baseTime = %" PRId64, mName, ns2us(baseTime));
309 nsecs_t phase = mPhase + listener.mPhase;
310 ALOGV("[%s] Phase = %" PRId64, mName, ns2us(phase));
311 baseTime -= phase;
312 ALOGV("[%s] baseTime - phase = %" PRId64, mName, ns2us(baseTime));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700313
Tim Murray4a4e4a22016-04-19 16:29:23 +0000314 // If our previous time is before the reference (because the reference
315 // has since been updated), the division by mPeriod will truncate
316 // towards zero instead of computing the floor. Since in all cases
317 // before the reference we want the next time to be effectively now, we
318 // set baseTime to -mPeriod so that numPeriods will be -1.
319 // When we add 1 and the phase, we will be at the correct event time for
320 // this period.
321 if (baseTime < 0) {
322 ALOGV("[%s] Correcting negative baseTime", mName);
323 baseTime = -mPeriod;
324 }
325
326 nsecs_t numPeriods = baseTime / mPeriod;
327 ALOGV("[%s] numPeriods = %" PRId64, mName, numPeriods);
328 nsecs_t t = (numPeriods + 1) * mPeriod + phase;
329 ALOGV("[%s] t = %" PRId64, mName, ns2us(t));
330 t += mReferenceTime;
331 ALOGV("[%s] Absolute t = %" PRId64, mName, ns2us(t));
332
333 // Check that it's been slightly more than half a period since the last
334 // event so that we don't accidentally fall into double-rate vsyncs
335 if (t - listener.mLastEventTime < (3 * mPeriod / 5)) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700336 t += mPeriod;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000337 ALOGV("[%s] Modifying t -> %" PRId64, mName, ns2us(t));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700338 }
339
Tim Murray4a4e4a22016-04-19 16:29:23 +0000340 t -= mWakeupLatency;
341 ALOGV("[%s] Corrected for wakeup latency -> %" PRId64, mName, ns2us(t));
342
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700343 return t;
344 }
345
Ana Krulec9a52b192018-07-12 18:18:47 -0400346 void fireCallbackInvocations(const std::vector<CallbackInvocation>& callbacks) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000347 if (kTraceDetailedInfo) ATRACE_CALL();
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700348 for (size_t i = 0; i < callbacks.size(); i++) {
349 callbacks[i].mCallback->onDispSyncEvent(callbacks[i].mEventTime);
350 }
351 }
352
Tim Murray4a4e4a22016-04-19 16:29:23 +0000353 const char* const mName;
354
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700355 bool mStop;
356
357 nsecs_t mPeriod;
358 nsecs_t mPhase;
Haixia Shi676b1f62015-10-28 16:19:01 -0700359 nsecs_t mReferenceTime;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700360 nsecs_t mWakeupLatency;
361
Tim Murray4a4e4a22016-04-19 16:29:23 +0000362 int64_t mFrameNumber;
363
Ana Krulec9a52b192018-07-12 18:18:47 -0400364 std::vector<EventListener> mEventListeners;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700365
366 Mutex mMutex;
367 Condition mCond;
368};
369
Tim Murray4a4e4a22016-04-19 16:29:23 +0000370#undef LOG_TAG
371#define LOG_TAG "DispSync"
372
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700373class ZeroPhaseTracer : public DispSync::Callback {
374public:
375 ZeroPhaseTracer() : mParity(false) {}
376
Mark Salyzyn92dc3fc2014-03-12 13:12:44 -0700377 virtual void onDispSyncEvent(nsecs_t /*when*/) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700378 mParity = !mParity;
379 ATRACE_INT("ZERO_PHASE_VSYNC", mParity ? 1 : 0);
380 }
381
382private:
383 bool mParity;
384};
385
Lloyd Pique78ce4182018-01-31 16:39:51 -0800386DispSync::DispSync(const char* name)
387 : mName(name), mRefreshSkipCount(0), mThread(new DispSyncThread(name)) {}
Andy McFadden645b1f72014-06-10 14:43:32 -0700388
Saurabh Shahf4174532017-07-13 10:45:07 -0700389DispSync::~DispSync() {}
390
391void DispSync::init(bool hasSyncFramework, int64_t dispSyncPresentTimeOffset) {
392 mIgnorePresentFences = !hasSyncFramework;
393 mPresentTimeOffset = dispSyncPresentTimeOffset;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700394 mThread->run("DispSync", PRIORITY_URGENT_DISPLAY + PRIORITY_MORE_FAVORABLE);
Saurabh Shahf4174532017-07-13 10:45:07 -0700395
Tim Murrayacff43d2016-07-29 13:57:24 -0700396 // set DispSync to SCHED_FIFO to minimize jitter
397 struct sched_param param = {0};
Tim Murray35520632016-09-07 12:18:17 -0700398 param.sched_priority = 2;
Tim Murrayacff43d2016-07-29 13:57:24 -0700399 if (sched_setscheduler(mThread->getTid(), SCHED_FIFO, &param) != 0) {
400 ALOGE("Couldn't set SCHED_FIFO for DispSyncThread");
401 }
402
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700403 reset();
404 beginResync();
405
Steven Thomasdfde8fa2018-04-19 16:00:58 -0700406 if (kTraceDetailedInfo && kEnableZeroPhaseTracer) {
407 mZeroPhaseTracer = std::make_unique<ZeroPhaseTracer>();
408 addEventListener("ZeroPhaseTracer", 0, mZeroPhaseTracer.get());
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700409 }
410}
411
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700412void DispSync::reset() {
413 Mutex::Autolock lock(mMutex);
Steven Thomasdfde8fa2018-04-19 16:00:58 -0700414 resetLocked();
415}
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700416
Steven Thomasdfde8fa2018-04-19 16:00:58 -0700417void DispSync::resetLocked() {
Haixia Shi676b1f62015-10-28 16:19:01 -0700418 mPhase = 0;
419 mReferenceTime = 0;
420 mModelUpdated = false;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700421 mNumResyncSamples = 0;
422 mFirstResyncSample = 0;
423 mNumResyncSamplesSincePresent = 0;
424 resetErrorLocked();
425}
426
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700427bool DispSync::addPresentFence(const std::shared_ptr<FenceTime>& fenceTime) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700428 Mutex::Autolock lock(mMutex);
429
Steven Thomasdfde8fa2018-04-19 16:00:58 -0700430 if (mIgnorePresentFences) {
431 return true;
432 }
433
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700434 mPresentFences[mPresentSampleOffset] = fenceTime;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700435 mPresentSampleOffset = (mPresentSampleOffset + 1) % NUM_PRESENT_SAMPLES;
436 mNumResyncSamplesSincePresent = 0;
437
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700438 updateErrorLocked();
439
Haixia Shi676b1f62015-10-28 16:19:01 -0700440 return !mModelUpdated || mError > kErrorThreshold;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700441}
442
443void DispSync::beginResync() {
444 Mutex::Autolock lock(mMutex);
Tim Murray4a4e4a22016-04-19 16:29:23 +0000445 ALOGV("[%s] beginResync", mName);
Haixia Shi676b1f62015-10-28 16:19:01 -0700446 mModelUpdated = false;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700447 mNumResyncSamples = 0;
448}
449
450bool DispSync::addResyncSample(nsecs_t timestamp) {
451 Mutex::Autolock lock(mMutex);
452
Tim Murray4a4e4a22016-04-19 16:29:23 +0000453 ALOGV("[%s] addResyncSample(%" PRId64 ")", mName, ns2us(timestamp));
454
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700455 size_t idx = (mFirstResyncSample + mNumResyncSamples) % MAX_RESYNC_SAMPLES;
456 mResyncSamples[idx] = timestamp;
Haixia Shi664339a2015-10-28 13:22:22 -0700457 if (mNumResyncSamples == 0) {
Haixia Shi676b1f62015-10-28 16:19:01 -0700458 mPhase = 0;
459 mReferenceTime = timestamp;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000460 ALOGV("[%s] First resync sample: mPeriod = %" PRId64 ", mPhase = 0, "
Lloyd Pique78ce4182018-01-31 16:39:51 -0800461 "mReferenceTime = %" PRId64,
462 mName, ns2us(mPeriod), ns2us(mReferenceTime));
Tim Murray4a4e4a22016-04-19 16:29:23 +0000463 mThread->updateModel(mPeriod, mPhase, mReferenceTime);
Haixia Shi664339a2015-10-28 13:22:22 -0700464 }
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700465
466 if (mNumResyncSamples < MAX_RESYNC_SAMPLES) {
467 mNumResyncSamples++;
468 } else {
469 mFirstResyncSample = (mFirstResyncSample + 1) % MAX_RESYNC_SAMPLES;
470 }
471
472 updateModelLocked();
473
474 if (mNumResyncSamplesSincePresent++ > MAX_RESYNC_SAMPLES_WITHOUT_PRESENT) {
475 resetErrorLocked();
476 }
477
Fabien Sanglardcbf153b2017-03-10 17:57:12 -0800478 if (mIgnorePresentFences) {
Steven Thomasdfde8fa2018-04-19 16:00:58 -0700479 // If we're ignoring the present fences we have no way to know whether
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700480 // or not we're synchronized with the HW vsyncs, so we just request
Steven Thomasdfde8fa2018-04-19 16:00:58 -0700481 // that the HW vsync events be turned on.
482 return true;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700483 }
484
Tim Murray4a4e4a22016-04-19 16:29:23 +0000485 // Check against kErrorThreshold / 2 to add some hysteresis before having to
486 // resync again
487 bool modelLocked = mModelUpdated && mError < (kErrorThreshold / 2);
Lloyd Pique78ce4182018-01-31 16:39:51 -0800488 ALOGV("[%s] addResyncSample returning %s", mName, modelLocked ? "locked" : "unlocked");
Tim Murray4a4e4a22016-04-19 16:29:23 +0000489 return !modelLocked;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700490}
491
Lloyd Pique78ce4182018-01-31 16:39:51 -0800492void DispSync::endResync() {}
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700493
Lloyd Piquee83f9312018-02-01 12:53:17 -0800494status_t DispSync::addEventListener(const char* name, nsecs_t phase, Callback* callback) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700495 Mutex::Autolock lock(mMutex);
Tim Murray4a4e4a22016-04-19 16:29:23 +0000496 return mThread->addEventListener(name, phase, callback);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700497}
498
Andy McFadden645b1f72014-06-10 14:43:32 -0700499void DispSync::setRefreshSkipCount(int count) {
500 Mutex::Autolock lock(mMutex);
501 ALOGD("setRefreshSkipCount(%d)", count);
502 mRefreshSkipCount = count;
503 updateModelLocked();
Ruchi Kandoif52b3c82014-04-24 16:42:35 -0700504}
505
Lloyd Piquee83f9312018-02-01 12:53:17 -0800506status_t DispSync::removeEventListener(Callback* callback) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700507 Mutex::Autolock lock(mMutex);
508 return mThread->removeEventListener(callback);
509}
510
Dan Stoza84d619e2018-03-28 17:07:36 -0700511status_t DispSync::changePhaseOffset(Callback* callback, nsecs_t phase) {
512 Mutex::Autolock lock(mMutex);
513 return mThread->changePhaseOffset(callback, phase);
514}
515
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700516void DispSync::setPeriod(nsecs_t period) {
517 Mutex::Autolock lock(mMutex);
David Sodman6d46c1e2018-07-13 12:59:48 -0700518 mPeriodBase = mPeriod = period;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700519 mPhase = 0;
Haixia Shi676b1f62015-10-28 16:19:01 -0700520 mReferenceTime = 0;
521 mThread->updateModel(mPeriod, mPhase, mReferenceTime);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700522}
523
David Sodman44b5de02018-08-21 16:28:53 -0700524void DispSync::scalePeriod(HWC2::Device::FrequencyScaler frequencyScaler) {
David Sodman6d46c1e2018-07-13 12:59:48 -0700525 Mutex::Autolock lock(mMutex);
526
527 // if only 1 of the properties is updated, we will get to this
528 // point "attempting" to set the scale to 1 when it is already
529 // 1. Check that special case so that we don't do a useless
530 // update of the model.
David Sodman44b5de02018-08-21 16:28:53 -0700531 if ((frequencyScaler.multiplier == 1) &&
532 (frequencyScaler.divisor == 1) &&
533 (mPeriod == mPeriodBase)) return;
David Sodman6d46c1e2018-07-13 12:59:48 -0700534
David Sodman44b5de02018-08-21 16:28:53 -0700535 mPeriod = mPeriodBase * frequencyScaler.multiplier / frequencyScaler.divisor;
David Sodman6d46c1e2018-07-13 12:59:48 -0700536 mThread->updateModel(mPeriod, mPhase, mReferenceTime);
537}
538
Lajos Molnar67d8bd62014-09-11 14:58:45 -0700539nsecs_t DispSync::getPeriod() {
540 // lock mutex as mPeriod changes multiple times in updateModelLocked
541 Mutex::Autolock lock(mMutex);
542 return mPeriod;
543}
544
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700545void DispSync::updateModelLocked() {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000546 ALOGV("[%s] updateModelLocked %zu", mName, mNumResyncSamples);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700547 if (mNumResyncSamples >= MIN_RESYNC_SAMPLES_FOR_UPDATE) {
Tim Murray4a4e4a22016-04-19 16:29:23 +0000548 ALOGV("[%s] Computing...", mName);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700549 nsecs_t durationSum = 0;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000550 nsecs_t minDuration = INT64_MAX;
551 nsecs_t maxDuration = 0;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700552 for (size_t i = 1; i < mNumResyncSamples; i++) {
553 size_t idx = (mFirstResyncSample + i) % MAX_RESYNC_SAMPLES;
554 size_t prev = (idx + MAX_RESYNC_SAMPLES - 1) % MAX_RESYNC_SAMPLES;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000555 nsecs_t duration = mResyncSamples[idx] - mResyncSamples[prev];
556 durationSum += duration;
557 minDuration = min(minDuration, duration);
558 maxDuration = max(maxDuration, duration);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700559 }
560
Tim Murray4a4e4a22016-04-19 16:29:23 +0000561 // Exclude the min and max from the average
562 durationSum -= minDuration + maxDuration;
David Sodman6d46c1e2018-07-13 12:59:48 -0700563 mPeriodBase = mPeriod = durationSum / (mNumResyncSamples - 3);
Tim Murray4a4e4a22016-04-19 16:29:23 +0000564
565 ALOGV("[%s] mPeriod = %" PRId64, mName, ns2us(mPeriod));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700566
567 double sampleAvgX = 0;
568 double sampleAvgY = 0;
569 double scale = 2.0 * M_PI / double(mPeriod);
Tim Murray4a4e4a22016-04-19 16:29:23 +0000570 // Intentionally skip the first sample
571 for (size_t i = 1; i < mNumResyncSamples; i++) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700572 size_t idx = (mFirstResyncSample + i) % MAX_RESYNC_SAMPLES;
Haixia Shi676b1f62015-10-28 16:19:01 -0700573 nsecs_t sample = mResyncSamples[idx] - mReferenceTime;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700574 double samplePhase = double(sample % mPeriod) * scale;
575 sampleAvgX += cos(samplePhase);
576 sampleAvgY += sin(samplePhase);
577 }
578
Tim Murray4a4e4a22016-04-19 16:29:23 +0000579 sampleAvgX /= double(mNumResyncSamples - 1);
580 sampleAvgY /= double(mNumResyncSamples - 1);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700581
582 mPhase = nsecs_t(atan2(sampleAvgY, sampleAvgX) / scale);
583
Tim Murray4a4e4a22016-04-19 16:29:23 +0000584 ALOGV("[%s] mPhase = %" PRId64, mName, ns2us(mPhase));
585
586 if (mPhase < -(mPeriod / 2)) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700587 mPhase += mPeriod;
Tim Murray4a4e4a22016-04-19 16:29:23 +0000588 ALOGV("[%s] Adjusting mPhase -> %" PRId64, mName, ns2us(mPhase));
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700589 }
590
Andy McFadden5167ec62014-05-22 13:08:43 -0700591 if (kTraceDetailedInfo) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700592 ATRACE_INT64("DispSync:Period", mPeriod);
Tim Murray4a4e4a22016-04-19 16:29:23 +0000593 ATRACE_INT64("DispSync:Phase", mPhase + mPeriod / 2);
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700594 }
595
Andy McFadden645b1f72014-06-10 14:43:32 -0700596 // Artificially inflate the period if requested.
597 mPeriod += mPeriod * mRefreshSkipCount;
598
Haixia Shi676b1f62015-10-28 16:19:01 -0700599 mThread->updateModel(mPeriod, mPhase, mReferenceTime);
600 mModelUpdated = true;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700601 }
602}
603
604void DispSync::updateErrorLocked() {
Haixia Shi676b1f62015-10-28 16:19:01 -0700605 if (!mModelUpdated) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700606 return;
607 }
608
Andy McFadden645b1f72014-06-10 14:43:32 -0700609 // Need to compare present fences against the un-adjusted refresh period,
610 // since they might arrive between two events.
611 nsecs_t period = mPeriod / (1 + mRefreshSkipCount);
612
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700613 int numErrSamples = 0;
614 nsecs_t sqErrSum = 0;
615
616 for (size_t i = 0; i < NUM_PRESENT_SAMPLES; i++) {
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700617 // Only check for the cached value of signal time to avoid unecessary
618 // syscalls. It is the responsibility of the DispSync owner to
619 // call getSignalTime() periodically so the cache is updated when the
620 // fence signals.
621 nsecs_t time = mPresentFences[i]->getCachedSignalTime();
Lloyd Pique78ce4182018-01-31 16:39:51 -0800622 if (time == Fence::SIGNAL_TIME_PENDING || time == Fence::SIGNAL_TIME_INVALID) {
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700623 continue;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700624 }
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700625
626 nsecs_t sample = time - mReferenceTime;
627 if (sample <= mPhase) {
628 continue;
629 }
630
631 nsecs_t sampleErr = (sample - mPhase) % period;
632 if (sampleErr > period / 2) {
633 sampleErr -= period;
634 }
635 sqErrSum += sampleErr * sampleErr;
636 numErrSamples++;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700637 }
638
639 if (numErrSamples > 0) {
640 mError = sqErrSum / numErrSamples;
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700641 mZeroErrSamplesCount = 0;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700642 } else {
643 mError = 0;
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700644 // Use mod ACCEPTABLE_ZERO_ERR_SAMPLES_COUNT to avoid log spam.
645 mZeroErrSamplesCount++;
Lloyd Pique78ce4182018-01-31 16:39:51 -0800646 ALOGE_IF((mZeroErrSamplesCount % ACCEPTABLE_ZERO_ERR_SAMPLES_COUNT) == 0,
647 "No present times for model error.");
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700648 }
649
Andy McFadden5167ec62014-05-22 13:08:43 -0700650 if (kTraceDetailedInfo) {
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700651 ATRACE_INT64("DispSync:Error", mError);
652 }
653}
654
655void DispSync::resetErrorLocked() {
656 mPresentSampleOffset = 0;
657 mError = 0;
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700658 mZeroErrSamplesCount = 0;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700659 for (size_t i = 0; i < NUM_PRESENT_SAMPLES; i++) {
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700660 mPresentFences[i] = FenceTime::NO_FENCE;
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700661 }
662}
663
Andy McFadden41d67d72014-04-25 16:58:34 -0700664nsecs_t DispSync::computeNextRefresh(int periodOffset) const {
Andy McFadden150ecd82014-05-08 14:56:50 -0700665 Mutex::Autolock lock(mMutex);
Andy McFadden41d67d72014-04-25 16:58:34 -0700666 nsecs_t now = systemTime(SYSTEM_TIME_MONOTONIC);
Haixia Shi676b1f62015-10-28 16:19:01 -0700667 nsecs_t phase = mReferenceTime + mPhase;
668 return (((now - phase) / mPeriod) + periodOffset + 1) * mPeriod + phase;
Andy McFadden41d67d72014-04-25 16:58:34 -0700669}
670
Steven Thomasdfde8fa2018-04-19 16:00:58 -0700671void DispSync::setIgnorePresentFences(bool ignore) {
672 Mutex::Autolock lock(mMutex);
673 if (mIgnorePresentFences != ignore) {
674 mIgnorePresentFences = ignore;
675 resetLocked();
676 }
677}
678
Andy McFaddenc751e922014-05-08 14:53:26 -0700679void DispSync::dump(String8& result) const {
680 Mutex::Autolock lock(mMutex);
Lloyd Pique78ce4182018-01-31 16:39:51 -0800681 result.appendFormat("present fences are %s\n", mIgnorePresentFences ? "ignored" : "used");
682 result.appendFormat("mPeriod: %" PRId64 " ns (%.3f fps; skipCount=%d)\n", mPeriod,
683 1000000000.0 / mPeriod, mRefreshSkipCount);
Andy McFadden5167ec62014-05-22 13:08:43 -0700684 result.appendFormat("mPhase: %" PRId64 " ns\n", mPhase);
Lloyd Pique78ce4182018-01-31 16:39:51 -0800685 result.appendFormat("mError: %" PRId64 " ns (sqrt=%.1f)\n", mError, sqrt(mError));
Andy McFadden5167ec62014-05-22 13:08:43 -0700686 result.appendFormat("mNumResyncSamplesSincePresent: %d (limit %d)\n",
Lloyd Pique78ce4182018-01-31 16:39:51 -0800687 mNumResyncSamplesSincePresent, MAX_RESYNC_SAMPLES_WITHOUT_PRESENT);
688 result.appendFormat("mNumResyncSamples: %zd (max %d)\n", mNumResyncSamples, MAX_RESYNC_SAMPLES);
Andy McFaddenc751e922014-05-08 14:53:26 -0700689
690 result.appendFormat("mResyncSamples:\n");
691 nsecs_t previous = -1;
692 for (size_t i = 0; i < mNumResyncSamples; i++) {
693 size_t idx = (mFirstResyncSample + i) % MAX_RESYNC_SAMPLES;
694 nsecs_t sampleTime = mResyncSamples[idx];
695 if (i == 0) {
Andy McFadden5167ec62014-05-22 13:08:43 -0700696 result.appendFormat(" %" PRId64 "\n", sampleTime);
Andy McFaddenc751e922014-05-08 14:53:26 -0700697 } else {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800698 result.appendFormat(" %" PRId64 " (+%" PRId64 ")\n", sampleTime,
699 sampleTime - previous);
Andy McFaddenc751e922014-05-08 14:53:26 -0700700 }
701 previous = sampleTime;
702 }
703
Lloyd Pique78ce4182018-01-31 16:39:51 -0800704 result.appendFormat("mPresentFences [%d]:\n", NUM_PRESENT_SAMPLES);
Andy McFadden5167ec62014-05-22 13:08:43 -0700705 nsecs_t now = systemTime(SYSTEM_TIME_MONOTONIC);
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700706 previous = Fence::SIGNAL_TIME_INVALID;
Andy McFaddenc751e922014-05-08 14:53:26 -0700707 for (size_t i = 0; i < NUM_PRESENT_SAMPLES; i++) {
708 size_t idx = (i + mPresentSampleOffset) % NUM_PRESENT_SAMPLES;
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700709 nsecs_t presentTime = mPresentFences[idx]->getSignalTime();
710 if (presentTime == Fence::SIGNAL_TIME_PENDING) {
Andy McFaddenc751e922014-05-08 14:53:26 -0700711 result.appendFormat(" [unsignaled fence]\n");
Lloyd Pique78ce4182018-01-31 16:39:51 -0800712 } else if (presentTime == Fence::SIGNAL_TIME_INVALID) {
Brian Andersonfbc80ae2017-05-26 16:23:54 -0700713 result.appendFormat(" [invalid fence]\n");
714 } else if (previous == Fence::SIGNAL_TIME_PENDING ||
Lloyd Pique78ce4182018-01-31 16:39:51 -0800715 previous == Fence::SIGNAL_TIME_INVALID) {
Andy McFadden5167ec62014-05-22 13:08:43 -0700716 result.appendFormat(" %" PRId64 " (%.3f ms ago)\n", presentTime,
Lloyd Pique78ce4182018-01-31 16:39:51 -0800717 (now - presentTime) / 1000000.0);
Andy McFaddenc751e922014-05-08 14:53:26 -0700718 } else {
Lloyd Pique78ce4182018-01-31 16:39:51 -0800719 result.appendFormat(" %" PRId64 " (+%" PRId64 " / %.3f) (%.3f ms ago)\n", presentTime,
720 presentTime - previous, (presentTime - previous) / (double)mPeriod,
721 (now - presentTime) / 1000000.0);
Andy McFaddenc751e922014-05-08 14:53:26 -0700722 }
723 previous = presentTime;
724 }
Andy McFadden5167ec62014-05-22 13:08:43 -0700725
726 result.appendFormat("current monotonic time: %" PRId64 "\n", now);
Andy McFaddenc751e922014-05-08 14:53:26 -0700727}
728
Lloyd Pique41be5d22018-06-21 13:11:48 -0700729} // namespace impl
730
Jamie Gennisfaf77cc2013-07-30 15:10:32 -0700731} // namespace android