2 * Copyright (C) 2007 The Android Open Source Project
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #define ATRACE_TAG ATRACE_TAG_GRAPHICS
23 #include <stdatomic.h>
25 #include <sys/types.h>
31 #include <cutils/properties.h>
34 #include <binder/IPCThreadState.h>
35 #include <binder/IServiceManager.h>
36 #include <binder/PermissionCache.h>
38 #include <ui/DisplayInfo.h>
39 #include <ui/DisplayStatInfo.h>
41 #include <gui/BufferQueue.h>
42 #include <gui/GuiConfig.h>
43 #include <gui/IDisplayEventConnection.h>
44 #include <gui/Surface.h>
46 #include <ui/GraphicBufferAllocator.h>
47 #include <ui/HdrCapabilities.h>
48 #include <ui/PixelFormat.h>
49 #include <ui/UiConfig.h>
51 #include <utils/misc.h>
52 #include <utils/String8.h>
53 #include <utils/String16.h>
54 #include <utils/StopWatch.h>
55 #include <utils/Timers.h>
56 #include <utils/Trace.h>
58 #include <private/android_filesystem_config.h>
59 #include <private/gui/SyncFeatures.h>
65 #include "Colorizer.h"
66 #include "DdmConnection.h"
67 #include "DisplayDevice.h"
69 #include "EventControlThread.h"
70 #include "EventThread.h"
72 #include "LayerVector.h"
74 #include "MonitoredProducer.h"
75 #include "SurfaceFlinger.h"
77 #include "DisplayHardware/FramebufferSurface.h"
78 #include "DisplayHardware/HWComposer.h"
79 #include "DisplayHardware/VirtualDisplaySurface.h"
81 #include "Effects/Daltonizer.h"
83 #include "RenderEngine/RenderEngine.h"
84 #include <cutils/compiler.h>
86 #include <android/hardware/configstore/1.0/ISurfaceFlingerConfigs.h>
87 #include <configstore/Utils.h>
89 #define DISPLAY_COUNT 1
92 * DEBUG_SCREENSHOTS: set to true to check that screenshots are not all
95 #define DEBUG_SCREENSHOTS false
97 EGLAPI const char* eglQueryStringImplementationANDROID(EGLDisplay dpy, EGLint name);
100 // ---------------------------------------------------------------------------
102 using namespace android::hardware::configstore;
103 using namespace android::hardware::configstore::V1_0;
105 const String16 sHardwareTest("android.permission.HARDWARE_TEST");
106 const String16 sAccessSurfaceFlinger("android.permission.ACCESS_SURFACE_FLINGER");
107 const String16 sReadFramebuffer("android.permission.READ_FRAME_BUFFER");
108 const String16 sDump("android.permission.DUMP");
110 // ---------------------------------------------------------------------------
111 int64_t SurfaceFlinger::vsyncPhaseOffsetNs;
112 int64_t SurfaceFlinger::sfVsyncPhaseOffsetNs;
113 bool SurfaceFlinger::useContextPriority;
114 int64_t SurfaceFlinger::dispSyncPresentTimeOffset;
115 bool SurfaceFlinger::useHwcForRgbToYuv;
116 uint64_t SurfaceFlinger::maxVirtualDisplaySize;
117 bool SurfaceFlinger::hasSyncFramework;
118 int64_t SurfaceFlinger::maxFrameBufferAcquiredBuffers;
120 SurfaceFlinger::SurfaceFlinger()
121 : BnSurfaceComposer(),
122 mTransactionFlags(0),
123 mTransactionPending(false),
124 mAnimTransactionPending(false),
125 mLayersRemoved(false),
127 mRepaintEverything(0),
129 mBootTime(systemTime()),
130 mVisibleRegionsDirty(false),
131 mHwWorkListDirty(false),
132 mAnimCompositionPending(false),
136 mDebugDisableTransformHint(0),
137 mDebugInSwapBuffers(0),
138 mLastSwapBufferTime(0),
139 mDebugInTransaction(0),
140 mLastTransactionTime(0),
141 mBootFinished(false),
142 mForceFullDamage(false),
144 mPrimaryDispSync("PrimaryDispSync"),
145 mPrimaryHWVsyncEnabled(false),
146 mHWVsyncAvailable(false),
148 mHasColorMatrix(false),
149 mHasPoweredOff(false),
155 ALOGI("SurfaceFlinger is starting");
157 vsyncPhaseOffsetNs = getInt64< ISurfaceFlingerConfigs,
158 &ISurfaceFlingerConfigs::vsyncEventPhaseOffsetNs>(1000000);
160 sfVsyncPhaseOffsetNs = getInt64< ISurfaceFlingerConfigs,
161 &ISurfaceFlingerConfigs::vsyncSfEventPhaseOffsetNs>(1000000);
163 maxVirtualDisplaySize = getUInt64<ISurfaceFlingerConfigs,
164 &ISurfaceFlingerConfigs::maxVirtualDisplaySize>(0);
166 hasSyncFramework = getBool< ISurfaceFlingerConfigs,
167 &ISurfaceFlingerConfigs::hasSyncFramework>(true);
169 useContextPriority = getBool< ISurfaceFlingerConfigs,
170 &ISurfaceFlingerConfigs::useContextPriority>(false);
172 dispSyncPresentTimeOffset = getInt64< ISurfaceFlingerConfigs,
173 &ISurfaceFlingerConfigs::presentTimeOffsetFromVSyncNs>(0);
175 useHwcForRgbToYuv = getBool< ISurfaceFlingerConfigs,
176 &ISurfaceFlingerConfigs::useHwcForRGBtoYUV>(false);
178 maxFrameBufferAcquiredBuffers = getInt64< ISurfaceFlingerConfigs,
179 &ISurfaceFlingerConfigs::maxFrameBufferAcquiredBuffers>(2);
181 char value[PROPERTY_VALUE_MAX];
183 property_get("ro.bq.gpu_to_cpu_unsupported", value, "0");
184 mGpuToCpuSupported = !atoi(value);
186 property_get("debug.sf.showupdates", value, "0");
187 mDebugRegion = atoi(value);
189 property_get("debug.sf.ddms", value, "0");
190 mDebugDDMS = atoi(value);
192 if (!startDdmConnection()) {
193 // start failed, and DDMS debugging not enabled
197 ALOGI_IF(mDebugRegion, "showupdates enabled");
198 ALOGI_IF(mDebugDDMS, "DDMS debugging enabled");
200 property_get("debug.sf.enable_hwc_vds", value, "0");
201 mUseHwcVirtualDisplays = atoi(value);
202 ALOGI_IF(!mUseHwcVirtualDisplays, "Enabling HWC virtual displays");
204 property_get("ro.sf.disable_triple_buffer", value, "1");
205 mLayerTripleBufferingDisabled = atoi(value);
206 ALOGI_IF(mLayerTripleBufferingDisabled, "Disabling Triple Buffering");
209 void SurfaceFlinger::onFirstRef()
211 mEventQueue.init(this);
214 SurfaceFlinger::~SurfaceFlinger()
216 EGLDisplay display = eglGetDisplay(EGL_DEFAULT_DISPLAY);
217 eglMakeCurrent(display, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);
218 eglTerminate(display);
221 void SurfaceFlinger::binderDied(const wp<IBinder>& /* who */)
223 // the window manager died on us. prepare its eulogy.
225 // restore initial conditions (default device unblank, etc)
226 initializeDisplays();
228 // restart the boot-animation
232 static sp<ISurfaceComposerClient> initClient(const sp<Client>& client) {
233 status_t err = client->initCheck();
234 if (err == NO_ERROR) {
240 sp<ISurfaceComposerClient> SurfaceFlinger::createConnection() {
241 return initClient(new Client(this));
244 sp<ISurfaceComposerClient> SurfaceFlinger::createScopedConnection(
245 const sp<IGraphicBufferProducer>& gbp) {
246 if (authenticateSurfaceTexture(gbp) == false) {
249 const auto& layer = (static_cast<MonitoredProducer*>(gbp.get()))->getLayer();
250 if (layer == nullptr) {
254 return initClient(new Client(this, layer));
257 sp<IBinder> SurfaceFlinger::createDisplay(const String8& displayName,
260 class DisplayToken : public BBinder {
261 sp<SurfaceFlinger> flinger;
262 virtual ~DisplayToken() {
263 // no more references, this display must be terminated
264 Mutex::Autolock _l(flinger->mStateLock);
265 flinger->mCurrentState.displays.removeItem(this);
266 flinger->setTransactionFlags(eDisplayTransactionNeeded);
269 explicit DisplayToken(const sp<SurfaceFlinger>& flinger)
274 sp<BBinder> token = new DisplayToken(this);
276 Mutex::Autolock _l(mStateLock);
277 DisplayDeviceState info(DisplayDevice::DISPLAY_VIRTUAL, secure);
278 info.displayName = displayName;
279 mCurrentState.displays.add(token, info);
280 mInterceptor.saveDisplayCreation(info);
284 void SurfaceFlinger::destroyDisplay(const sp<IBinder>& display) {
285 Mutex::Autolock _l(mStateLock);
287 ssize_t idx = mCurrentState.displays.indexOfKey(display);
289 ALOGW("destroyDisplay: invalid display token");
293 const DisplayDeviceState& info(mCurrentState.displays.valueAt(idx));
294 if (!info.isVirtualDisplay()) {
295 ALOGE("destroyDisplay called for non-virtual display");
298 mInterceptor.saveDisplayDeletion(info.displayId);
299 mCurrentState.displays.removeItemsAt(idx);
300 setTransactionFlags(eDisplayTransactionNeeded);
303 void SurfaceFlinger::createBuiltinDisplayLocked(DisplayDevice::DisplayType type) {
304 ALOGW_IF(mBuiltinDisplays[type],
305 "Overwriting display token for display type %d", type);
306 mBuiltinDisplays[type] = new BBinder();
307 // All non-virtual displays are currently considered secure.
308 DisplayDeviceState info(type, true);
309 mCurrentState.displays.add(mBuiltinDisplays[type], info);
310 mInterceptor.saveDisplayCreation(info);
313 sp<IBinder> SurfaceFlinger::getBuiltInDisplay(int32_t id) {
314 if (uint32_t(id) >= DisplayDevice::NUM_BUILTIN_DISPLAY_TYPES) {
315 ALOGE("getDefaultDisplay: id=%d is not a valid default display id", id);
318 return mBuiltinDisplays[id];
321 void SurfaceFlinger::bootFinished()
323 if (mStartBootAnimThread->join() != NO_ERROR) {
324 ALOGE("Join StartBootAnimThread failed!");
326 const nsecs_t now = systemTime();
327 const nsecs_t duration = now - mBootTime;
328 ALOGI("Boot is finished (%ld ms)", long(ns2ms(duration)) );
329 mBootFinished = true;
331 // wait patiently for the window manager death
332 const String16 name("window");
333 sp<IBinder> window(defaultServiceManager()->getService(name));
335 window->linkToDeath(static_cast<IBinder::DeathRecipient*>(this));
338 // stop boot animation
339 // formerly we would just kill the process, but we now ask it to exit so it
340 // can choose where to stop the animation.
341 property_set("service.bootanim.exit", "1");
343 const int LOGTAG_SF_STOP_BOOTANIM = 60110;
344 LOG_EVENT_LONG(LOGTAG_SF_STOP_BOOTANIM,
345 ns2ms(systemTime(SYSTEM_TIME_MONOTONIC)));
348 void SurfaceFlinger::deleteTextureAsync(uint32_t texture) {
349 class MessageDestroyGLTexture : public MessageBase {
350 RenderEngine& engine;
353 MessageDestroyGLTexture(RenderEngine& engine, uint32_t texture)
354 : engine(engine), texture(texture) {
356 virtual bool handler() {
357 engine.deleteTextures(1, &texture);
361 postMessageAsync(new MessageDestroyGLTexture(getRenderEngine(), texture));
364 class DispSyncSource : public VSyncSource, private DispSync::Callback {
366 DispSyncSource(DispSync* dispSync, nsecs_t phaseOffset, bool traceVsync,
370 mTraceVsync(traceVsync),
371 mVsyncOnLabel(String8::format("VsyncOn-%s", name)),
372 mVsyncEventLabel(String8::format("VSYNC-%s", name)),
377 mPhaseOffset(phaseOffset),
380 virtual ~DispSyncSource() {}
382 virtual void setVSyncEnabled(bool enable) {
383 Mutex::Autolock lock(mVsyncMutex);
385 status_t err = mDispSync->addEventListener(mName, mPhaseOffset,
386 static_cast<DispSync::Callback*>(this));
387 if (err != NO_ERROR) {
388 ALOGE("error registering vsync callback: %s (%d)",
389 strerror(-err), err);
391 //ATRACE_INT(mVsyncOnLabel.string(), 1);
393 status_t err = mDispSync->removeEventListener(
394 static_cast<DispSync::Callback*>(this));
395 if (err != NO_ERROR) {
396 ALOGE("error unregistering vsync callback: %s (%d)",
397 strerror(-err), err);
399 //ATRACE_INT(mVsyncOnLabel.string(), 0);
404 virtual void setCallback(const sp<VSyncSource::Callback>& callback) {
405 Mutex::Autolock lock(mCallbackMutex);
406 mCallback = callback;
409 virtual void setPhaseOffset(nsecs_t phaseOffset) {
410 Mutex::Autolock lock(mVsyncMutex);
412 // Normalize phaseOffset to [0, period)
413 auto period = mDispSync->getPeriod();
414 phaseOffset %= period;
415 if (phaseOffset < 0) {
416 // If we're here, then phaseOffset is in (-period, 0). After this
417 // operation, it will be in (0, period)
418 phaseOffset += period;
420 mPhaseOffset = phaseOffset;
422 // If we're not enabled, we don't need to mess with the listeners
427 // Remove the listener with the old offset
428 status_t err = mDispSync->removeEventListener(
429 static_cast<DispSync::Callback*>(this));
430 if (err != NO_ERROR) {
431 ALOGE("error unregistering vsync callback: %s (%d)",
432 strerror(-err), err);
435 // Add a listener with the new offset
436 err = mDispSync->addEventListener(mName, mPhaseOffset,
437 static_cast<DispSync::Callback*>(this));
438 if (err != NO_ERROR) {
439 ALOGE("error registering vsync callback: %s (%d)",
440 strerror(-err), err);
445 virtual void onDispSyncEvent(nsecs_t when) {
446 sp<VSyncSource::Callback> callback;
448 Mutex::Autolock lock(mCallbackMutex);
449 callback = mCallback;
452 mValue = (mValue + 1) % 2;
453 ATRACE_INT(mVsyncEventLabel.string(), mValue);
457 if (callback != NULL) {
458 callback->onVSyncEvent(when);
462 const char* const mName;
466 const bool mTraceVsync;
467 const String8 mVsyncOnLabel;
468 const String8 mVsyncEventLabel;
472 Mutex mCallbackMutex; // Protects the following
473 sp<VSyncSource::Callback> mCallback;
475 Mutex mVsyncMutex; // Protects the following
476 nsecs_t mPhaseOffset;
480 class InjectVSyncSource : public VSyncSource {
482 InjectVSyncSource() {}
484 virtual ~InjectVSyncSource() {}
486 virtual void setCallback(const sp<VSyncSource::Callback>& callback) {
487 std::lock_guard<std::mutex> lock(mCallbackMutex);
488 mCallback = callback;
491 virtual void onInjectSyncEvent(nsecs_t when) {
492 std::lock_guard<std::mutex> lock(mCallbackMutex);
493 mCallback->onVSyncEvent(when);
496 virtual void setVSyncEnabled(bool) {}
497 virtual void setPhaseOffset(nsecs_t) {}
500 std::mutex mCallbackMutex; // Protects the following
501 sp<VSyncSource::Callback> mCallback;
504 void SurfaceFlinger::init() {
505 ALOGI( "SurfaceFlinger's main thread ready to run. "
506 "Initializing graphics H/W...");
508 Mutex::Autolock _l(mStateLock);
510 // initialize EGL for the default display
511 mEGLDisplay = eglGetDisplay(EGL_DEFAULT_DISPLAY);
512 eglInitialize(mEGLDisplay, NULL, NULL);
514 // start the EventThread
515 sp<VSyncSource> vsyncSrc = new DispSyncSource(&mPrimaryDispSync,
516 vsyncPhaseOffsetNs, true, "app");
517 mEventThread = new EventThread(vsyncSrc, *this, false);
518 sp<VSyncSource> sfVsyncSrc = new DispSyncSource(&mPrimaryDispSync,
519 sfVsyncPhaseOffsetNs, true, "sf");
520 mSFEventThread = new EventThread(sfVsyncSrc, *this, true);
521 mEventQueue.setEventThread(mSFEventThread);
523 // set EventThread and SFEventThread to SCHED_FIFO to minimize jitter
524 struct sched_param param = {0};
525 param.sched_priority = 2;
526 if (sched_setscheduler(mSFEventThread->getTid(), SCHED_FIFO, ¶m) != 0) {
527 ALOGE("Couldn't set SCHED_FIFO for SFEventThread");
529 if (sched_setscheduler(mEventThread->getTid(), SCHED_FIFO, ¶m) != 0) {
530 ALOGE("Couldn't set SCHED_FIFO for EventThread");
533 // Initialize the H/W composer object. There may or may not be an
534 // actual hardware composer underneath.
535 mHwc = new HWComposer(this,
536 *static_cast<HWComposer::EventHandler *>(this));
538 // get a RenderEngine for the given display / config (can't fail)
539 mRenderEngine = RenderEngine::create(mEGLDisplay,
540 mHwc->getVisualID(), 0);
542 // retrieve the EGL context that was selected/created
543 mEGLContext = mRenderEngine->getEGLContext();
545 LOG_ALWAYS_FATAL_IF(mEGLContext == EGL_NO_CONTEXT,
546 "couldn't create EGLContext");
548 // Inform native graphics APIs that the present timestamp is NOT supported:
549 property_set(kTimestampProperty, "0");
551 // initialize our non-virtual displays
552 for (size_t i=0 ; i<DisplayDevice::NUM_BUILTIN_DISPLAY_TYPES ; i++) {
553 DisplayDevice::DisplayType type((DisplayDevice::DisplayType)i);
554 // set-up the displays that are already connected
555 if (mHwc->isConnected(i) || type==DisplayDevice::DISPLAY_PRIMARY) {
556 // All non-virtual displays are currently considered secure.
557 bool isSecure = true;
558 createBuiltinDisplayLocked(type);
559 wp<IBinder> token = mBuiltinDisplays[i];
561 sp<IGraphicBufferProducer> producer;
562 sp<IGraphicBufferConsumer> consumer;
563 BufferQueue::createBufferQueue(&producer, &consumer);
565 sp<FramebufferSurface> fbs = new FramebufferSurface(*mHwc, i,
567 int32_t hwcId = allocateHwcDisplayId(type);
568 sp<DisplayDevice> hw = new DisplayDevice(this,
569 type, hwcId, mHwc->getFormat(hwcId), isSecure, token,
571 mRenderEngine->getEGLConfig(), false);
572 if (i > DisplayDevice::DISPLAY_PRIMARY) {
573 // FIXME: currently we don't get blank/unblank requests
574 // for displays other than the main display, so we always
575 // assume a connected display is unblanked.
576 ALOGD("marking display %zu as acquired/unblanked", i);
577 hw->setPowerMode(HWC_POWER_MODE_NORMAL);
579 mDisplays.add(token, hw);
583 // make the GLContext current so that we can create textures when creating Layers
584 // (which may happens before we render something)
585 getDefaultDisplayDeviceLocked()->makeCurrent(mEGLDisplay, mEGLContext);
587 mEventControlThread = new EventControlThread(this);
588 mEventControlThread->run("EventControl", PRIORITY_URGENT_DISPLAY);
590 // set a fake vsync period if there is no HWComposer
591 if (mHwc->initCheck() != NO_ERROR) {
592 mPrimaryDispSync.setPeriod(16666667);
595 // initialize our drawing state
596 mDrawingState = mCurrentState;
598 // set initial conditions (e.g. unblank default device)
599 initializeDisplays();
601 mRenderEngine->primeCache();
603 mStartBootAnimThread = new StartBootAnimThread();
604 if (mStartBootAnimThread->Start() != NO_ERROR) {
605 ALOGE("Run StartBootAnimThread failed!");
608 ALOGV("Done initializing");
611 int32_t SurfaceFlinger::allocateHwcDisplayId(DisplayDevice::DisplayType type) {
612 return (uint32_t(type) < DisplayDevice::NUM_BUILTIN_DISPLAY_TYPES) ?
613 type : mHwc->allocateDisplayId();
616 void SurfaceFlinger::startBootAnim() {
617 // Start boot animation service by setting a property mailbox
618 // if property setting thread is already running, Start() will be just a NOP
619 mStartBootAnimThread->Start();
620 // Wait until property was set
621 if (mStartBootAnimThread->join() != NO_ERROR) {
622 ALOGE("Join StartBootAnimThread failed!");
626 size_t SurfaceFlinger::getMaxTextureSize() const {
627 return mRenderEngine->getMaxTextureSize();
630 size_t SurfaceFlinger::getMaxViewportDims() const {
631 return mRenderEngine->getMaxViewportDims();
634 // ----------------------------------------------------------------------------
636 bool SurfaceFlinger::authenticateSurfaceTexture(
637 const sp<IGraphicBufferProducer>& bufferProducer) const {
638 Mutex::Autolock _l(mStateLock);
639 return authenticateSurfaceTextureLocked(bufferProducer);
642 bool SurfaceFlinger::authenticateSurfaceTextureLocked(
643 const sp<IGraphicBufferProducer>& bufferProducer) const {
644 sp<IBinder> surfaceTextureBinder(IInterface::asBinder(bufferProducer));
645 return mGraphicBufferProducerList.indexOf(surfaceTextureBinder) >= 0;
648 status_t SurfaceFlinger::getSupportedFrameTimestamps(
649 std::vector<FrameEvent>* outSupported) const {
651 FrameEvent::REQUESTED_PRESENT,
654 FrameEvent::FIRST_REFRESH_START,
655 FrameEvent::LAST_REFRESH_START,
656 FrameEvent::GPU_COMPOSITION_DONE,
657 FrameEvent::DEQUEUE_READY,
663 status_t SurfaceFlinger::getDisplayConfigs(const sp<IBinder>& display,
664 Vector<DisplayInfo>* configs) {
665 if ((configs == NULL) || (display.get() == NULL)) {
669 int32_t type = getDisplayType(display);
670 if (type < 0) return type;
672 // TODO: Not sure if display density should handled by SF any longer
674 static int getDensityFromProperty(char const* propName) {
675 char property[PROPERTY_VALUE_MAX];
677 if (property_get(propName, property, NULL) > 0) {
678 density = atoi(property);
683 static int getEmuDensity() {
684 return getDensityFromProperty("qemu.sf.lcd_density"); }
685 static int getBuildDensity() {
686 return getDensityFromProperty("ro.sf.lcd_density"); }
691 const Vector<HWComposer::DisplayConfig>& hwConfigs =
692 getHwComposer().getConfigs(type);
693 for (size_t c = 0; c < hwConfigs.size(); ++c) {
694 const HWComposer::DisplayConfig& hwConfig = hwConfigs[c];
695 DisplayInfo info = DisplayInfo();
697 float xdpi = hwConfig.xdpi;
698 float ydpi = hwConfig.ydpi;
700 if (type == DisplayDevice::DISPLAY_PRIMARY) {
701 // The density of the device is provided by a build property
702 float density = Density::getBuildDensity() / 160.0f;
704 // the build doesn't provide a density -- this is wrong!
706 ALOGE("ro.sf.lcd_density must be defined as a build property");
707 density = xdpi / 160.0f;
709 if (Density::getEmuDensity()) {
710 // if "qemu.sf.lcd_density" is specified, it overrides everything
711 xdpi = ydpi = density = Density::getEmuDensity();
714 info.density = density;
716 // TODO: this needs to go away (currently needed only by webkit)
717 sp<const DisplayDevice> hw(getDefaultDisplayDevice());
718 info.orientation = hw->getOrientation();
720 // TODO: where should this value come from?
721 static const int TV_DENSITY = 213;
722 info.density = TV_DENSITY / 160.0f;
723 info.orientation = 0;
726 info.w = hwConfig.width;
727 info.h = hwConfig.height;
730 info.fps = float(1e9 / hwConfig.refresh);
731 info.appVsyncOffset = vsyncPhaseOffsetNs;
733 // This is how far in advance a buffer must be queued for
734 // presentation at a given time. If you want a buffer to appear
735 // on the screen at time N, you must submit the buffer before
736 // (N - presentationDeadline).
738 // Normally it's one full refresh period (to give SF a chance to
739 // latch the buffer), but this can be reduced by configuring a
740 // DispSync offset. Any additional delays introduced by the hardware
741 // composer or panel must be accounted for here.
743 // We add an additional 1ms to allow for processing time and
744 // differences between the ideal and actual refresh rate.
745 info.presentationDeadline =
746 hwConfig.refresh - sfVsyncPhaseOffsetNs + 1000000;
748 // All non-virtual displays are currently considered secure.
751 configs->push_back(info);
757 status_t SurfaceFlinger::getDisplayStats(const sp<IBinder>& /* display */,
758 DisplayStatInfo* stats) {
763 // FIXME for now we always return stats for the primary display
764 memset(stats, 0, sizeof(*stats));
765 stats->vsyncTime = mPrimaryDispSync.computeNextRefresh(0);
766 stats->vsyncPeriod = mPrimaryDispSync.getPeriod();
770 int SurfaceFlinger::getActiveConfig(const sp<IBinder>& display) {
771 sp<const DisplayDevice> device(getDisplayDevice(display));
772 if (device != NULL) {
773 return device->getActiveConfig();
778 void SurfaceFlinger::setActiveConfigInternal(const sp<DisplayDevice>& hw, int mode) {
779 ALOGD("Set active config mode=%d, type=%d flinger=%p", mode, hw->getDisplayType(),
781 int32_t type = hw->getDisplayType();
782 int currentMode = hw->getActiveConfig();
784 if (mode == currentMode) {
785 ALOGD("Screen type=%d is already mode=%d", hw->getDisplayType(), mode);
789 if (type >= DisplayDevice::NUM_BUILTIN_DISPLAY_TYPES) {
790 ALOGW("Trying to set config for virtual display");
794 hw->setActiveConfig(mode);
795 getHwComposer().setActiveConfig(type, mode);
798 status_t SurfaceFlinger::setActiveConfig(const sp<IBinder>& display, int mode) {
799 class MessageSetActiveConfig: public MessageBase {
800 SurfaceFlinger& mFlinger;
801 sp<IBinder> mDisplay;
804 MessageSetActiveConfig(SurfaceFlinger& flinger, const sp<IBinder>& disp,
806 mFlinger(flinger), mDisplay(disp) { mMode = mode; }
807 virtual bool handler() {
808 Vector<DisplayInfo> configs;
809 mFlinger.getDisplayConfigs(mDisplay, &configs);
810 if (mMode < 0 || mMode >= static_cast<int>(configs.size())) {
811 ALOGE("Attempt to set active config = %d for display with %zu configs",
812 mMode, configs.size());
814 sp<DisplayDevice> hw(mFlinger.getDisplayDevice(mDisplay));
816 ALOGE("Attempt to set active config = %d for null display %p",
817 mMode, mDisplay.get());
818 } else if (hw->getDisplayType() >= DisplayDevice::DISPLAY_VIRTUAL) {
819 ALOGW("Attempt to set active config = %d for virtual display",
822 mFlinger.setActiveConfigInternal(hw, mMode);
827 sp<MessageBase> msg = new MessageSetActiveConfig(*this, display, mode);
828 postMessageSync(msg);
832 status_t SurfaceFlinger::getDisplayColorModes(const sp<IBinder>& display,
833 Vector<android_color_mode_t>* outColorModes) {
834 if (outColorModes == nullptr || display.get() == nullptr) {
838 int32_t type = getDisplayType(display);
839 if (type < 0) return type;
841 std::set<android_color_mode_t> colorModes;
842 for (const HWComposer::DisplayConfig& hwConfig : getHwComposer().getConfigs(type)) {
843 colorModes.insert(hwConfig.colorMode);
846 outColorModes->clear();
847 std::copy(colorModes.cbegin(), colorModes.cend(), std::back_inserter(*outColorModes));
852 android_color_mode_t SurfaceFlinger::getActiveColorMode(const sp<IBinder>& display) {
853 if (display.get() == nullptr) return static_cast<android_color_mode_t>(BAD_VALUE);
855 int32_t type = getDisplayType(display);
856 if (type < 0) return static_cast<android_color_mode_t>(type);
858 return getHwComposer().getColorMode(type);
861 status_t SurfaceFlinger::setActiveColorMode(const sp<IBinder>& display,
862 android_color_mode_t colorMode) {
863 if (display.get() == nullptr || colorMode < 0) {
867 int32_t type = getDisplayType(display);
868 if (type < 0) return type;
869 const Vector<HWComposer::DisplayConfig>& hwConfigs = getHwComposer().getConfigs(type);
870 HWComposer::DisplayConfig desiredConfig = hwConfigs[getHwComposer().getCurrentConfig(type)];
871 desiredConfig.colorMode = colorMode;
872 for (size_t c = 0; c < hwConfigs.size(); ++c) {
873 const HWComposer::DisplayConfig config = hwConfigs[c];
874 if (config == desiredConfig) {
875 return setActiveConfig(display, c);
881 status_t SurfaceFlinger::clearAnimationFrameStats() {
882 Mutex::Autolock _l(mStateLock);
883 mAnimFrameTracker.clearStats();
887 status_t SurfaceFlinger::getAnimationFrameStats(FrameStats* outStats) const {
888 Mutex::Autolock _l(mStateLock);
889 mAnimFrameTracker.getStats(outStats);
893 status_t SurfaceFlinger::getHdrCapabilities(const sp<IBinder>& /*display*/,
894 HdrCapabilities* outCapabilities) const {
895 // HWC1 does not provide HDR capabilities
896 *outCapabilities = HdrCapabilities();
900 status_t SurfaceFlinger::enableVSyncInjections(bool enable) {
901 if (enable == mInjectVSyncs) {
906 mInjectVSyncs = enable;
907 ALOGV("VSync Injections enabled");
908 if (mVSyncInjector.get() == nullptr) {
909 mVSyncInjector = new InjectVSyncSource();
910 mInjectorEventThread = new EventThread(mVSyncInjector, *this, false);
912 mEventQueue.setEventThread(mInjectorEventThread);
914 mInjectVSyncs = enable;
915 ALOGV("VSync Injections disabled");
916 mEventQueue.setEventThread(mSFEventThread);
917 mVSyncInjector.clear();
922 status_t SurfaceFlinger::injectVSync(nsecs_t when) {
923 if (!mInjectVSyncs) {
924 ALOGE("VSync Injections not enabled");
927 if (mInjectVSyncs && mInjectorEventThread.get() != nullptr) {
928 ALOGV("Injecting VSync inside SurfaceFlinger");
929 mVSyncInjector->onInjectSyncEvent(when);
934 // ----------------------------------------------------------------------------
936 sp<IDisplayEventConnection> SurfaceFlinger::createDisplayEventConnection(
937 ISurfaceComposer::VsyncSource vsyncSource) {
938 if (vsyncSource == eVsyncSourceSurfaceFlinger) {
939 return mSFEventThread->createEventConnection();
941 return mEventThread->createEventConnection();
945 // ----------------------------------------------------------------------------
947 void SurfaceFlinger::waitForEvent() {
948 mEventQueue.waitMessage();
951 void SurfaceFlinger::signalTransaction() {
952 mEventQueue.invalidate();
955 void SurfaceFlinger::signalLayerUpdate() {
956 mEventQueue.invalidate();
959 void SurfaceFlinger::signalRefresh() {
960 mEventQueue.refresh();
963 status_t SurfaceFlinger::postMessageAsync(const sp<MessageBase>& msg,
964 nsecs_t reltime, uint32_t /* flags */) {
965 return mEventQueue.postMessage(msg, reltime);
968 status_t SurfaceFlinger::postMessageSync(const sp<MessageBase>& msg,
969 nsecs_t reltime, uint32_t /* flags */) {
970 status_t res = mEventQueue.postMessage(msg, reltime);
971 if (res == NO_ERROR) {
977 void SurfaceFlinger::run() {
983 void SurfaceFlinger::enableHardwareVsync() {
984 Mutex::Autolock _l(mHWVsyncLock);
985 if (!mPrimaryHWVsyncEnabled && mHWVsyncAvailable) {
986 mPrimaryDispSync.beginResync();
987 //eventControl(HWC_DISPLAY_PRIMARY, SurfaceFlinger::EVENT_VSYNC, true);
988 mEventControlThread->setVsyncEnabled(true);
989 mPrimaryHWVsyncEnabled = true;
993 void SurfaceFlinger::resyncToHardwareVsync(bool makeAvailable) {
994 Mutex::Autolock _l(mHWVsyncLock);
997 mHWVsyncAvailable = true;
998 } else if (!mHWVsyncAvailable) {
999 // Hardware vsync is not currently available, so abort the resync
1004 const nsecs_t period =
1005 getHwComposer().getRefreshPeriod(HWC_DISPLAY_PRIMARY);
1007 mPrimaryDispSync.reset();
1008 mPrimaryDispSync.setPeriod(period);
1010 if (!mPrimaryHWVsyncEnabled) {
1011 mPrimaryDispSync.beginResync();
1012 //eventControl(HWC_DISPLAY_PRIMARY, SurfaceFlinger::EVENT_VSYNC, true);
1013 mEventControlThread->setVsyncEnabled(true);
1014 mPrimaryHWVsyncEnabled = true;
1018 void SurfaceFlinger::disableHardwareVsync(bool makeUnavailable) {
1019 Mutex::Autolock _l(mHWVsyncLock);
1020 if (mPrimaryHWVsyncEnabled) {
1021 //eventControl(HWC_DISPLAY_PRIMARY, SurfaceFlinger::EVENT_VSYNC, false);
1022 mEventControlThread->setVsyncEnabled(false);
1023 mPrimaryDispSync.endResync();
1024 mPrimaryHWVsyncEnabled = false;
1026 if (makeUnavailable) {
1027 mHWVsyncAvailable = false;
1031 void SurfaceFlinger::resyncWithRateLimit() {
1032 static constexpr nsecs_t kIgnoreDelay = ms2ns(500);
1033 if (systemTime() - mLastSwapTime > kIgnoreDelay) {
1034 resyncToHardwareVsync(false);
1038 void SurfaceFlinger::onVSyncReceived(HWComposer* /*composer*/, int type,
1039 nsecs_t timestamp) {
1040 bool needsHwVsync = false;
1042 { // Scope for the lock
1043 Mutex::Autolock _l(mHWVsyncLock);
1044 if (type == 0 && mPrimaryHWVsyncEnabled) {
1045 needsHwVsync = mPrimaryDispSync.addResyncSample(timestamp);
1050 enableHardwareVsync();
1052 disableHardwareVsync(false);
1056 void SurfaceFlinger::getCompositorTiming(CompositorTiming* compositorTiming) {
1057 std::lock_guard<std::mutex> lock(mCompositorTimingLock);
1058 *compositorTiming = mCompositorTiming;
1061 void SurfaceFlinger::onHotplugReceived(HWComposer* /*composer*/, int type, bool connected) {
1062 if (mEventThread == NULL) {
1063 // This is a temporary workaround for b/7145521. A non-null pointer
1064 // does not mean EventThread has finished initializing, so this
1065 // is not a correct fix.
1066 ALOGW("WARNING: EventThread not started, ignoring hotplug");
1070 if (uint32_t(type) < DisplayDevice::NUM_BUILTIN_DISPLAY_TYPES) {
1071 Mutex::Autolock _l(mStateLock);
1073 createBuiltinDisplayLocked((DisplayDevice::DisplayType)type);
1075 mCurrentState.displays.removeItem(mBuiltinDisplays[type]);
1076 mBuiltinDisplays[type].clear();
1078 setTransactionFlags(eDisplayTransactionNeeded);
1080 // Defer EventThread notification until SF has updated mDisplays.
1084 void SurfaceFlinger::onInvalidateReceived(HWComposer* /*composer*/) {
1085 repaintEverything();
1088 void SurfaceFlinger::eventControl(int disp, int event, int enabled) {
1090 getHwComposer().eventControl(disp, event, enabled);
1093 void SurfaceFlinger::onMessageReceived(int32_t what) {
1096 case MessageQueue::INVALIDATE: {
1097 bool refreshNeeded = handleMessageTransaction();
1098 refreshNeeded |= handleMessageInvalidate();
1099 refreshNeeded |= mRepaintEverything;
1100 if (refreshNeeded) {
1101 // Signal a refresh if a transaction modified the window state,
1102 // a new buffer was latched, or if HWC has requested a full
1108 case MessageQueue::REFRESH: {
1109 handleMessageRefresh();
1115 bool SurfaceFlinger::handleMessageTransaction() {
1116 uint32_t transactionFlags = peekTransactionFlags();
1117 if (transactionFlags) {
1118 handleTransaction(transactionFlags);
1124 bool SurfaceFlinger::handleMessageInvalidate() {
1126 return handlePageFlip();
1129 void SurfaceFlinger::handleMessageRefresh() {
1132 nsecs_t refreshStartTime = systemTime(SYSTEM_TIME_MONOTONIC);
1134 preComposition(refreshStartTime);
1135 rebuildLayerStacks();
1137 doDebugFlashRegions();
1139 postComposition(refreshStartTime);
1142 void SurfaceFlinger::doDebugFlashRegions()
1144 // is debugging enabled
1145 if (CC_LIKELY(!mDebugRegion))
1148 const bool repaintEverything = mRepaintEverything;
1149 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
1150 const sp<DisplayDevice>& hw(mDisplays[dpy]);
1151 if (hw->isDisplayOn()) {
1152 // transform the dirty region into this screen's coordinate space
1153 const Region dirtyRegion(hw->getDirtyRegion(repaintEverything));
1154 if (!dirtyRegion.isEmpty()) {
1155 // redraw the whole screen
1156 doComposeSurfaces(hw, Region(hw->bounds()));
1158 // and draw the dirty region
1159 const int32_t height = hw->getHeight();
1160 RenderEngine& engine(getRenderEngine());
1161 engine.fillRegionWithColor(dirtyRegion, height, 1, 0, 1, 1);
1163 hw->compositionComplete();
1164 hw->swapBuffers(getHwComposer());
1171 if (mDebugRegion > 1) {
1172 usleep(mDebugRegion * 1000);
1175 HWComposer& hwc(getHwComposer());
1176 if (hwc.initCheck() == NO_ERROR) {
1177 status_t err = hwc.prepare();
1178 ALOGE_IF(err, "HWComposer::prepare failed (%s)", strerror(-err));
1182 void SurfaceFlinger::preComposition(nsecs_t refreshStartTime)
1184 bool needExtraInvalidate = false;
1185 mDrawingState.traverseInZOrder([&](Layer* layer) {
1186 if (layer->onPreComposition(refreshStartTime)) {
1187 needExtraInvalidate = true;
1191 if (needExtraInvalidate) {
1192 signalLayerUpdate();
1196 void SurfaceFlinger::updateCompositorTiming(
1197 nsecs_t vsyncPhase, nsecs_t vsyncInterval, nsecs_t compositeTime,
1198 std::shared_ptr<FenceTime>& presentFenceTime) {
1199 // Update queue of past composite+present times and determine the
1200 // most recently known composite to present latency.
1201 mCompositePresentTimes.push({compositeTime, presentFenceTime});
1202 nsecs_t compositeToPresentLatency = -1;
1203 while (!mCompositePresentTimes.empty()) {
1204 CompositePresentTime& cpt = mCompositePresentTimes.front();
1205 // Cached values should have been updated before calling this method,
1206 // which helps avoid duplicate syscalls.
1207 nsecs_t displayTime = cpt.display->getCachedSignalTime();
1208 if (displayTime == Fence::SIGNAL_TIME_PENDING) {
1211 compositeToPresentLatency = displayTime - cpt.composite;
1212 mCompositePresentTimes.pop();
1215 // Don't let mCompositePresentTimes grow unbounded, just in case.
1216 while (mCompositePresentTimes.size() > 16) {
1217 mCompositePresentTimes.pop();
1220 setCompositorTimingSnapped(
1221 vsyncPhase, vsyncInterval, compositeToPresentLatency);
1224 void SurfaceFlinger::setCompositorTimingSnapped(nsecs_t vsyncPhase,
1225 nsecs_t vsyncInterval, nsecs_t compositeToPresentLatency) {
1226 // Integer division and modulo round toward 0 not -inf, so we need to
1227 // treat negative and positive offsets differently.
1228 nsecs_t idealLatency = (sfVsyncPhaseOffsetNs > 0) ?
1229 (vsyncInterval - (sfVsyncPhaseOffsetNs % vsyncInterval)) :
1230 ((-sfVsyncPhaseOffsetNs) % vsyncInterval);
1232 // Just in case sfVsyncPhaseOffsetNs == -vsyncInterval.
1233 if (idealLatency <= 0) {
1234 idealLatency = vsyncInterval;
1237 // Snap the latency to a value that removes scheduling jitter from the
1238 // composition and present times, which often have >1ms of jitter.
1239 // Reducing jitter is important if an app attempts to extrapolate
1240 // something (such as user input) to an accurate diasplay time.
1241 // Snapping also allows an app to precisely calculate sfVsyncPhaseOffsetNs
1242 // with (presentLatency % interval).
1243 nsecs_t bias = vsyncInterval / 2;
1244 int64_t extraVsyncs =
1245 (compositeToPresentLatency - idealLatency + bias) / vsyncInterval;
1246 nsecs_t snappedCompositeToPresentLatency = (extraVsyncs > 0) ?
1247 idealLatency + (extraVsyncs * vsyncInterval) : idealLatency;
1249 std::lock_guard<std::mutex> lock(mCompositorTimingLock);
1250 mCompositorTiming.deadline = vsyncPhase - idealLatency;
1251 mCompositorTiming.interval = vsyncInterval;
1252 mCompositorTiming.presentLatency = snappedCompositeToPresentLatency;
1255 void SurfaceFlinger::postComposition(nsecs_t refreshStartTime)
1257 const HWComposer& hwc = getHwComposer();
1258 const sp<const DisplayDevice> hw(getDefaultDisplayDevice());
1260 std::shared_ptr<FenceTime> glCompositionDoneFenceTime;
1261 if (getHwComposer().hasGlesComposition(hw->getHwcDisplayId())) {
1262 glCompositionDoneFenceTime =
1263 std::make_shared<FenceTime>(hw->getClientTargetAcquireFence());
1264 mGlCompositionDoneTimeline.push(glCompositionDoneFenceTime);
1266 glCompositionDoneFenceTime = FenceTime::NO_FENCE;
1268 mGlCompositionDoneTimeline.updateSignalTimes();
1270 sp<Fence> retireFence = mHwc->getDisplayFence(HWC_DISPLAY_PRIMARY);
1271 auto retireFenceTime = std::make_shared<FenceTime>(retireFence);
1272 mDisplayTimeline.push(retireFenceTime);
1273 mDisplayTimeline.updateSignalTimes();
1275 nsecs_t vsyncPhase = mPrimaryDispSync.computeNextRefresh(0);
1276 nsecs_t vsyncInterval = mPrimaryDispSync.getPeriod();
1278 // We use the refreshStartTime which might be sampled a little later than
1279 // when we started doing work for this frame, but that should be okay
1280 // since updateCompositorTiming has snapping logic.
1281 updateCompositorTiming(
1282 vsyncPhase, vsyncInterval, refreshStartTime, retireFenceTime);
1283 CompositorTiming compositorTiming;
1285 std::lock_guard<std::mutex> lock(mCompositorTimingLock);
1286 compositorTiming = mCompositorTiming;
1289 mDrawingState.traverseInZOrder([&](Layer* layer) {
1290 // TODO(brianderson): The retire fence is incorrectly passed in as the
1291 // present fence. Fix this if this file lives on.
1292 bool frameLatched = layer->onPostComposition(glCompositionDoneFenceTime,
1293 retireFenceTime, compositorTiming);
1295 recordBufferingStats(layer->getName().string(),
1296 layer->getOccupancyHistory(false));
1300 if (retireFence->isValid()) {
1301 if (mPrimaryDispSync.addPresentFence(retireFence)) {
1302 enableHardwareVsync();
1304 disableHardwareVsync(false);
1308 if (!hasSyncFramework) {
1309 if (hw->isDisplayOn()) {
1310 enableHardwareVsync();
1314 if (mAnimCompositionPending) {
1315 mAnimCompositionPending = false;
1317 if (retireFenceTime->isValid()) {
1318 mAnimFrameTracker.setActualPresentFence(std::move(retireFenceTime));
1320 // The HWC doesn't support present fences, so use the refresh
1321 // timestamp instead.
1322 nsecs_t presentTime = hwc.getRefreshTimestamp(HWC_DISPLAY_PRIMARY);
1323 mAnimFrameTracker.setActualPresentTime(presentTime);
1325 mAnimFrameTracker.advanceFrame();
1328 if (hw->getPowerMode() == HWC_POWER_MODE_OFF) {
1332 nsecs_t currentTime = systemTime();
1333 if (mHasPoweredOff) {
1334 mHasPoweredOff = false;
1336 nsecs_t period = mPrimaryDispSync.getPeriod();
1337 nsecs_t elapsedTime = currentTime - mLastSwapTime;
1338 size_t numPeriods = static_cast<size_t>(elapsedTime / period);
1339 if (numPeriods < NUM_BUCKETS - 1) {
1340 mFrameBuckets[numPeriods] += elapsedTime;
1342 mFrameBuckets[NUM_BUCKETS - 1] += elapsedTime;
1344 mTotalTime += elapsedTime;
1346 mLastSwapTime = currentTime;
1349 void SurfaceFlinger::rebuildLayerStacks() {
1350 // rebuild the visible layer list per screen
1351 if (CC_UNLIKELY(mVisibleRegionsDirty)) {
1353 mVisibleRegionsDirty = false;
1354 invalidateHwcGeometry();
1356 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
1357 Region opaqueRegion;
1359 Vector< sp<Layer> > layersSortedByZ;
1360 const sp<DisplayDevice>& hw(mDisplays[dpy]);
1361 const Transform& tr(hw->getTransform());
1362 const Rect bounds(hw->getBounds());
1363 if (hw->isDisplayOn()) {
1364 computeVisibleRegions(hw->getLayerStack(), dirtyRegion,
1367 mDrawingState.traverseInZOrder([&](Layer* layer) {
1368 if (layer->getLayerStack() == hw->getLayerStack()) {
1369 Region drawRegion(tr.transform(
1370 layer->visibleNonTransparentRegion));
1371 drawRegion.andSelf(bounds);
1372 if (!drawRegion.isEmpty()) {
1373 layersSortedByZ.add(layer);
1378 hw->setVisibleLayersSortedByZ(layersSortedByZ);
1379 hw->undefinedRegion.set(bounds);
1380 hw->undefinedRegion.subtractSelf(tr.transform(opaqueRegion));
1381 hw->dirtyRegion.orSelf(dirtyRegion);
1386 void SurfaceFlinger::setUpHWComposer() {
1387 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
1388 bool dirty = !mDisplays[dpy]->getDirtyRegion(false).isEmpty();
1389 bool empty = mDisplays[dpy]->getVisibleLayersSortedByZ().size() == 0;
1390 bool wasEmpty = !mDisplays[dpy]->lastCompositionHadVisibleLayers;
1392 // If nothing has changed (!dirty), don't recompose.
1393 // If something changed, but we don't currently have any visible layers,
1394 // and didn't when we last did a composition, then skip it this time.
1395 // The second rule does two things:
1396 // - When all layers are removed from a display, we'll emit one black
1397 // frame, then nothing more until we get new layers.
1398 // - When a display is created with a private layer stack, we won't
1399 // emit any black frames until a layer is added to the layer stack.
1400 bool mustRecompose = dirty && !(empty && wasEmpty);
1402 ALOGV_IF(mDisplays[dpy]->getDisplayType() == DisplayDevice::DISPLAY_VIRTUAL,
1403 "dpy[%zu]: %s composition (%sdirty %sempty %swasEmpty)", dpy,
1404 mustRecompose ? "doing" : "skipping",
1407 wasEmpty ? "+" : "-");
1409 mDisplays[dpy]->beginFrame(mustRecompose);
1411 if (mustRecompose) {
1412 mDisplays[dpy]->lastCompositionHadVisibleLayers = !empty;
1416 HWComposer& hwc(getHwComposer());
1417 if (hwc.initCheck() == NO_ERROR) {
1418 // build the h/w work list
1419 if (CC_UNLIKELY(mHwWorkListDirty)) {
1420 mHwWorkListDirty = false;
1421 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
1422 sp<const DisplayDevice> hw(mDisplays[dpy]);
1423 const int32_t id = hw->getHwcDisplayId();
1425 const Vector< sp<Layer> >& currentLayers(
1426 hw->getVisibleLayersSortedByZ());
1427 const size_t count = currentLayers.size();
1428 if (hwc.createWorkList(id, count) == NO_ERROR) {
1429 HWComposer::LayerListIterator cur = hwc.begin(id);
1430 const HWComposer::LayerListIterator end = hwc.end(id);
1431 for (size_t i=0 ; cur!=end && i<count ; ++i, ++cur) {
1432 const sp<Layer>& layer(currentLayers[i]);
1433 layer->setGeometry(hw, *cur);
1434 if (mDebugDisableHWC || mDebugRegion || mDaltonize || mHasColorMatrix) {
1443 // set the per-frame data
1444 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
1445 sp<const DisplayDevice> hw(mDisplays[dpy]);
1446 const int32_t id = hw->getHwcDisplayId();
1448 const Vector< sp<Layer> >& currentLayers(
1449 hw->getVisibleLayersSortedByZ());
1450 const size_t count = currentLayers.size();
1451 HWComposer::LayerListIterator cur = hwc.begin(id);
1452 const HWComposer::LayerListIterator end = hwc.end(id);
1453 for (size_t i=0 ; cur!=end && i<count ; ++i, ++cur) {
1455 * update the per-frame h/w composer data for each layer
1456 * and build the transparent region of the FB
1458 const sp<Layer>& layer(currentLayers[i]);
1459 layer->setPerFrameData(hw, *cur);
1464 // If possible, attempt to use the cursor overlay on each display.
1465 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
1466 sp<const DisplayDevice> hw(mDisplays[dpy]);
1467 const int32_t id = hw->getHwcDisplayId();
1469 const Vector< sp<Layer> >& currentLayers(
1470 hw->getVisibleLayersSortedByZ());
1471 const size_t count = currentLayers.size();
1472 HWComposer::LayerListIterator cur = hwc.begin(id);
1473 const HWComposer::LayerListIterator end = hwc.end(id);
1474 for (size_t i=0 ; cur!=end && i<count ; ++i, ++cur) {
1475 const sp<Layer>& layer(currentLayers[i]);
1476 if (layer->isPotentialCursor()) {
1477 cur->setIsCursorLayerHint();
1484 status_t err = hwc.prepare();
1485 ALOGE_IF(err, "HWComposer::prepare failed (%s)", strerror(-err));
1487 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
1488 sp<const DisplayDevice> hw(mDisplays[dpy]);
1489 hw->prepareFrame(hwc);
1494 void SurfaceFlinger::doComposition() {
1496 const bool repaintEverything = android_atomic_and(0, &mRepaintEverything);
1497 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
1498 const sp<DisplayDevice>& hw(mDisplays[dpy]);
1499 if (hw->isDisplayOn()) {
1500 // transform the dirty region into this screen's coordinate space
1501 const Region dirtyRegion(hw->getDirtyRegion(repaintEverything));
1503 // repaint the framebuffer (if needed)
1504 doDisplayComposition(hw, dirtyRegion);
1506 hw->dirtyRegion.clear();
1507 hw->flip(hw->swapRegion);
1508 hw->swapRegion.clear();
1510 // inform the h/w that we're done compositing
1511 hw->compositionComplete();
1516 void SurfaceFlinger::postFramebuffer()
1520 const nsecs_t now = systemTime();
1521 mDebugInSwapBuffers = now;
1523 HWComposer& hwc(getHwComposer());
1524 if (hwc.initCheck() == NO_ERROR) {
1525 if (!hwc.supportsFramebufferTarget()) {
1527 // "surface must be bound to the calling thread's current context,
1528 // for the current rendering API."
1529 getDefaultDisplayDevice()->makeCurrent(mEGLDisplay, mEGLContext);
1534 // make the default display current because the VirtualDisplayDevice code cannot
1535 // deal with dequeueBuffer() being called outside of the composition loop; however
1536 // the code below can call glFlush() which is allowed (and does in some case) call
1538 getDefaultDisplayDevice()->makeCurrent(mEGLDisplay, mEGLContext);
1540 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
1541 sp<const DisplayDevice> hw(mDisplays[dpy]);
1542 const Vector< sp<Layer> >& currentLayers(hw->getVisibleLayersSortedByZ());
1543 hw->onSwapBuffersCompleted(hwc);
1544 const size_t count = currentLayers.size();
1545 int32_t id = hw->getHwcDisplayId();
1546 if (id >=0 && hwc.initCheck() == NO_ERROR) {
1547 HWComposer::LayerListIterator cur = hwc.begin(id);
1548 const HWComposer::LayerListIterator end = hwc.end(id);
1549 for (size_t i = 0; cur != end && i < count; ++i, ++cur) {
1550 currentLayers[i]->onLayerDisplayed(hw, &*cur);
1553 for (size_t i = 0; i < count; i++) {
1554 currentLayers[i]->onLayerDisplayed(hw, NULL);
1559 mLastSwapBufferTime = systemTime() - now;
1560 mDebugInSwapBuffers = 0;
1562 uint32_t flipCount = getDefaultDisplayDevice()->getPageFlipCount();
1563 if (flipCount % LOG_FRAME_STATS_PERIOD == 0) {
1568 void SurfaceFlinger::handleTransaction(uint32_t transactionFlags)
1572 // here we keep a copy of the drawing state (that is the state that's
1573 // going to be overwritten by handleTransactionLocked()) outside of
1574 // mStateLock so that the side-effects of the State assignment
1575 // don't happen with mStateLock held (which can cause deadlocks).
1576 State drawingState(mDrawingState);
1578 Mutex::Autolock _l(mStateLock);
1579 const nsecs_t now = systemTime();
1580 mDebugInTransaction = now;
1582 // Here we're guaranteed that some transaction flags are set
1583 // so we can call handleTransactionLocked() unconditionally.
1584 // We call getTransactionFlags(), which will also clear the flags,
1585 // with mStateLock held to guarantee that mCurrentState won't change
1586 // until the transaction is committed.
1588 transactionFlags = getTransactionFlags(eTransactionMask);
1589 handleTransactionLocked(transactionFlags);
1591 mLastTransactionTime = systemTime() - now;
1592 mDebugInTransaction = 0;
1593 invalidateHwcGeometry();
1594 // here the transaction has been committed
1597 void SurfaceFlinger::handleTransactionLocked(uint32_t transactionFlags)
1599 // Notify all layers of available frames
1600 mCurrentState.traverseInZOrder([](Layer* layer) {
1601 layer->notifyAvailableFrames();
1605 * Traversal of the children
1606 * (perform the transaction for each of them if needed)
1609 if (transactionFlags & eTraversalNeeded) {
1610 mCurrentState.traverseInZOrder([&](Layer* layer) {
1611 uint32_t trFlags = layer->getTransactionFlags(eTransactionNeeded);
1612 if (!trFlags) return;
1614 const uint32_t flags = layer->doTransaction(0);
1615 if (flags & Layer::eVisibleRegion)
1616 mVisibleRegionsDirty = true;
1621 * Perform display own transactions if needed
1624 if (transactionFlags & eDisplayTransactionNeeded) {
1625 // here we take advantage of Vector's copy-on-write semantics to
1626 // improve performance by skipping the transaction entirely when
1627 // know that the lists are identical
1628 const KeyedVector< wp<IBinder>, DisplayDeviceState>& curr(mCurrentState.displays);
1629 const KeyedVector< wp<IBinder>, DisplayDeviceState>& draw(mDrawingState.displays);
1630 if (!curr.isIdenticalTo(draw)) {
1631 mVisibleRegionsDirty = true;
1632 const size_t cc = curr.size();
1633 size_t dc = draw.size();
1635 // find the displays that were removed
1636 // (ie: in drawing state but not in current state)
1637 // also handle displays that changed
1638 // (ie: displays that are in both lists)
1639 for (size_t i=0 ; i<dc ; i++) {
1640 const ssize_t j = curr.indexOfKey(draw.keyAt(i));
1642 // in drawing state but not in current state
1643 if (!draw[i].isMainDisplay()) {
1644 // Call makeCurrent() on the primary display so we can
1645 // be sure that nothing associated with this display
1647 const sp<const DisplayDevice> defaultDisplay(getDefaultDisplayDeviceLocked());
1648 defaultDisplay->makeCurrent(mEGLDisplay, mEGLContext);
1649 sp<DisplayDevice> hw(getDisplayDeviceLocked(draw.keyAt(i)));
1651 hw->disconnect(getHwComposer());
1652 if (draw[i].type < DisplayDevice::NUM_BUILTIN_DISPLAY_TYPES)
1653 mEventThread->onHotplugReceived(draw[i].type, false);
1654 mDisplays.removeItem(draw.keyAt(i));
1656 ALOGW("trying to remove the main display");
1659 // this display is in both lists. see if something changed.
1660 const DisplayDeviceState& state(curr[j]);
1661 const wp<IBinder>& display(curr.keyAt(j));
1662 const sp<IBinder> state_binder = IInterface::asBinder(state.surface);
1663 const sp<IBinder> draw_binder = IInterface::asBinder(draw[i].surface);
1664 if (state_binder != draw_binder) {
1665 // changing the surface is like destroying and
1666 // recreating the DisplayDevice, so we just remove it
1667 // from the drawing state, so that it get re-added
1669 sp<DisplayDevice> hw(getDisplayDeviceLocked(display));
1671 hw->disconnect(getHwComposer());
1672 mDisplays.removeItem(display);
1673 mDrawingState.displays.removeItemsAt(i);
1675 // at this point we must loop to the next item
1679 const sp<DisplayDevice> disp(getDisplayDeviceLocked(display));
1681 if (state.layerStack != draw[i].layerStack) {
1682 disp->setLayerStack(state.layerStack);
1684 if ((state.orientation != draw[i].orientation)
1685 || (state.viewport != draw[i].viewport)
1686 || (state.frame != draw[i].frame))
1688 disp->setProjection(state.orientation,
1689 state.viewport, state.frame);
1691 if (state.width != draw[i].width || state.height != draw[i].height) {
1692 disp->setDisplaySize(state.width, state.height);
1698 // find displays that were added
1699 // (ie: in current state but not in drawing state)
1700 for (size_t i=0 ; i<cc ; i++) {
1701 if (draw.indexOfKey(curr.keyAt(i)) < 0) {
1702 const DisplayDeviceState& state(curr[i]);
1704 sp<DisplaySurface> dispSurface;
1705 sp<IGraphicBufferProducer> producer;
1706 sp<IGraphicBufferProducer> bqProducer;
1707 sp<IGraphicBufferConsumer> bqConsumer;
1708 BufferQueue::createBufferQueue(&bqProducer, &bqConsumer);
1710 int32_t hwcDisplayId = -1;
1711 if (state.isVirtualDisplay()) {
1712 // Virtual displays without a surface are dormant:
1713 // they have external state (layer stack, projection,
1714 // etc.) but no internal state (i.e. a DisplayDevice).
1715 if (state.surface != NULL) {
1718 int status = state.surface->query(
1719 NATIVE_WINDOW_WIDTH, &width);
1720 ALOGE_IF(status != NO_ERROR,
1721 "Unable to query width (%d)", status);
1723 status = state.surface->query(
1724 NATIVE_WINDOW_HEIGHT, &height);
1725 ALOGE_IF(status != NO_ERROR,
1726 "Unable to query height (%d)", status);
1727 if (mUseHwcVirtualDisplays &&
1728 (SurfaceFlinger::maxVirtualDisplaySize == 0 ||
1729 (width <= static_cast<int>(SurfaceFlinger::maxVirtualDisplaySize) &&
1730 height <= static_cast<int>(SurfaceFlinger::maxVirtualDisplaySize)))) {
1731 hwcDisplayId = allocateHwcDisplayId(state.type);
1734 sp<VirtualDisplaySurface> vds = new VirtualDisplaySurface(
1735 *mHwc, hwcDisplayId, state.surface,
1736 bqProducer, bqConsumer, state.displayName);
1742 ALOGE_IF(state.surface!=NULL,
1743 "adding a supported display, but rendering "
1744 "surface is provided (%p), ignoring it",
1745 state.surface.get());
1746 hwcDisplayId = allocateHwcDisplayId(state.type);
1747 // for supported (by hwc) displays we provide our
1748 // own rendering surface
1749 dispSurface = new FramebufferSurface(*mHwc, state.type,
1751 producer = bqProducer;
1754 const wp<IBinder>& display(curr.keyAt(i));
1755 if (dispSurface != NULL) {
1756 sp<DisplayDevice> hw = new DisplayDevice(this,
1757 state.type, hwcDisplayId,
1758 mHwc->getFormat(hwcDisplayId), state.isSecure,
1759 display, dispSurface, producer,
1760 mRenderEngine->getEGLConfig(), false);
1761 hw->setLayerStack(state.layerStack);
1762 hw->setProjection(state.orientation,
1763 state.viewport, state.frame);
1764 hw->setDisplayName(state.displayName);
1765 mDisplays.add(display, hw);
1766 if (state.isVirtualDisplay()) {
1767 if (hwcDisplayId >= 0) {
1768 mHwc->setVirtualDisplayProperties(hwcDisplayId,
1769 hw->getWidth(), hw->getHeight(),
1773 mEventThread->onHotplugReceived(state.type, true);
1781 if (transactionFlags & (eTraversalNeeded|eDisplayTransactionNeeded)) {
1782 // The transform hint might have changed for some layers
1783 // (either because a display has changed, or because a layer
1786 // Walk through all the layers in currentLayers,
1787 // and update their transform hint.
1789 // If a layer is visible only on a single display, then that
1790 // display is used to calculate the hint, otherwise we use the
1793 // NOTE: we do this here, rather than in rebuildLayerStacks() so that
1794 // the hint is set before we acquire a buffer from the surface texture.
1796 // NOTE: layer transactions have taken place already, so we use their
1797 // drawing state. However, SurfaceFlinger's own transaction has not
1798 // happened yet, so we must use the current state layer list
1799 // (soon to become the drawing state list).
1801 sp<const DisplayDevice> disp;
1802 uint32_t currentlayerStack = 0;
1804 mCurrentState.traverseInZOrder([&](Layer* layer) {
1805 // NOTE: we rely on the fact that layers are sorted by
1806 // layerStack first (so we don't have to traverse the list
1807 // of displays for every layer).
1808 uint32_t layerStack = layer->getLayerStack();
1809 if (first || currentlayerStack != layerStack) {
1810 currentlayerStack = layerStack;
1811 // figure out if this layerstack is mirrored
1812 // (more than one display) if so, pick the default display,
1813 // if not, pick the only display it's on.
1815 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
1816 sp<const DisplayDevice> hw(mDisplays[dpy]);
1817 if (hw->getLayerStack() == currentlayerStack) {
1828 // NOTE: TEMPORARY FIX ONLY. Real fix should cause layers to
1829 // redraw after transform hint changes. See bug 8508397.
1831 // could be null when this layer is using a layerStack
1832 // that is not visible on any display. Also can occur at
1833 // screen off/on times.
1834 disp = getDefaultDisplayDeviceLocked();
1836 layer->updateTransformHint(disp);
1844 * Perform our own transaction if needed
1848 mLayersAdded = false;
1849 // Layers have been added.
1850 mVisibleRegionsDirty = true;
1853 // some layers might have been removed, so
1854 // we need to update the regions they're exposing.
1855 if (mLayersRemoved) {
1856 mLayersRemoved = false;
1857 mVisibleRegionsDirty = true;
1858 mDrawingState.traverseInZOrder([&](Layer* layer) {
1859 if (mLayersPendingRemoval.indexOf(layer) >= 0) {
1860 // this layer is not visible anymore
1861 // TODO: we could traverse the tree from front to back and
1862 // compute the actual visible region
1863 // TODO: we could cache the transformed region
1865 visibleReg.set(layer->computeScreenBounds());
1866 invalidateLayerStack(layer->getLayerStack(), visibleReg);
1871 commitTransaction();
1873 updateCursorAsync();
1876 void SurfaceFlinger::updateCursorAsync()
1878 HWComposer& hwc(getHwComposer());
1879 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
1880 sp<const DisplayDevice> hw(mDisplays[dpy]);
1881 const int32_t id = hw->getHwcDisplayId();
1885 const Vector< sp<Layer> >& currentLayers(
1886 hw->getVisibleLayersSortedByZ());
1887 const size_t count = currentLayers.size();
1888 HWComposer::LayerListIterator cur = hwc.begin(id);
1889 const HWComposer::LayerListIterator end = hwc.end(id);
1890 for (size_t i=0 ; cur!=end && i<count ; ++i, ++cur) {
1891 if (cur->getCompositionType() != HWC_CURSOR_OVERLAY) {
1894 const sp<Layer>& layer(currentLayers[i]);
1895 Rect cursorPos = layer->getPosition(hw);
1896 hwc.setCursorPositionAsync(id, cursorPos);
1902 void SurfaceFlinger::commitTransaction()
1904 if (!mLayersPendingRemoval.isEmpty()) {
1905 // Notify removed layers now that they can't be drawn from
1906 for (const auto& l : mLayersPendingRemoval) {
1907 recordBufferingStats(l->getName().string(),
1908 l->getOccupancyHistory(true));
1911 mLayersPendingRemoval.clear();
1914 // If this transaction is part of a window animation then the next frame
1915 // we composite should be considered an animation as well.
1916 mAnimCompositionPending = mAnimTransactionPending;
1918 mDrawingState = mCurrentState;
1919 mDrawingState.traverseInZOrder([](Layer* layer) {
1920 layer->commitChildList();
1922 mTransactionPending = false;
1923 mAnimTransactionPending = false;
1924 mTransactionCV.broadcast();
1927 void SurfaceFlinger::computeVisibleRegions(uint32_t layerStack,
1928 Region& outDirtyRegion, Region& outOpaqueRegion)
1932 Region aboveOpaqueLayers;
1933 Region aboveCoveredLayers;
1936 outDirtyRegion.clear();
1938 mDrawingState.traverseInReverseZOrder([&](Layer* layer) {
1939 // start with the whole surface at its current location
1940 const Layer::State& s(layer->getDrawingState());
1942 // only consider the layers on the given layer stack
1943 if (layer->getLayerStack() != layerStack)
1947 * opaqueRegion: area of a surface that is fully opaque.
1949 Region opaqueRegion;
1952 * visibleRegion: area of a surface that is visible on screen
1953 * and not fully transparent. This is essentially the layer's
1954 * footprint minus the opaque regions above it.
1955 * Areas covered by a translucent surface are considered visible.
1957 Region visibleRegion;
1960 * coveredRegion: area of a surface that is covered by all
1961 * visible regions above it (which includes the translucent areas).
1963 Region coveredRegion;
1966 * transparentRegion: area of a surface that is hinted to be completely
1967 * transparent. This is only used to tell when the layer has no visible
1968 * non-transparent regions and can be removed from the layer list. It
1969 * does not affect the visibleRegion of this layer or any layers
1970 * beneath it. The hint may not be correct if apps don't respect the
1971 * SurfaceView restrictions (which, sadly, some don't).
1973 Region transparentRegion;
1976 // handle hidden surfaces by setting the visible region to empty
1977 if (CC_LIKELY(layer->isVisible())) {
1978 const bool translucent = !layer->isOpaque(s);
1979 Rect bounds(layer->computeScreenBounds());
1980 visibleRegion.set(bounds);
1981 Transform tr = layer->getTransform();
1982 if (!visibleRegion.isEmpty()) {
1983 // Remove the transparent area from the visible region
1985 if (tr.preserveRects()) {
1986 // transform the transparent region
1987 transparentRegion = tr.transform(s.activeTransparentRegion);
1989 // transformation too complex, can't do the
1990 // transparent region optimization.
1991 transparentRegion.clear();
1995 // compute the opaque region
1996 const int32_t layerOrientation = tr.getOrientation();
1997 if (s.alpha==255 && !translucent &&
1998 ((layerOrientation & Transform::ROT_INVALID) == false)) {
1999 // the opaque region is the layer's footprint
2000 opaqueRegion = visibleRegion;
2005 // Clip the covered region to the visible region
2006 coveredRegion = aboveCoveredLayers.intersect(visibleRegion);
2008 // Update aboveCoveredLayers for next (lower) layer
2009 aboveCoveredLayers.orSelf(visibleRegion);
2011 // subtract the opaque region covered by the layers above us
2012 visibleRegion.subtractSelf(aboveOpaqueLayers);
2014 // compute this layer's dirty region
2015 if (layer->contentDirty) {
2016 // we need to invalidate the whole region
2017 dirty = visibleRegion;
2018 // as well, as the old visible region
2019 dirty.orSelf(layer->visibleRegion);
2020 layer->contentDirty = false;
2022 /* compute the exposed region:
2023 * the exposed region consists of two components:
2024 * 1) what's VISIBLE now and was COVERED before
2025 * 2) what's EXPOSED now less what was EXPOSED before
2027 * note that (1) is conservative, we start with the whole
2028 * visible region but only keep what used to be covered by
2029 * something -- which mean it may have been exposed.
2031 * (2) handles areas that were not covered by anything but got
2032 * exposed because of a resize.
2034 const Region newExposed = visibleRegion - coveredRegion;
2035 const Region oldVisibleRegion = layer->visibleRegion;
2036 const Region oldCoveredRegion = layer->coveredRegion;
2037 const Region oldExposed = oldVisibleRegion - oldCoveredRegion;
2038 dirty = (visibleRegion&oldCoveredRegion) | (newExposed-oldExposed);
2040 dirty.subtractSelf(aboveOpaqueLayers);
2042 // accumulate to the screen dirty region
2043 outDirtyRegion.orSelf(dirty);
2045 // Update aboveOpaqueLayers for next (lower) layer
2046 aboveOpaqueLayers.orSelf(opaqueRegion);
2048 // Store the visible region in screen space
2049 layer->setVisibleRegion(visibleRegion);
2050 layer->setCoveredRegion(coveredRegion);
2051 layer->setVisibleNonTransparentRegion(
2052 visibleRegion.subtract(transparentRegion));
2055 outOpaqueRegion = aboveOpaqueLayers;
2058 void SurfaceFlinger::invalidateLayerStack(uint32_t layerStack,
2059 const Region& dirty) {
2060 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
2061 const sp<DisplayDevice>& hw(mDisplays[dpy]);
2062 if (hw->getLayerStack() == layerStack) {
2063 hw->dirtyRegion.orSelf(dirty);
2068 bool SurfaceFlinger::handlePageFlip()
2070 nsecs_t latchTime = systemTime();
2073 bool visibleRegions = false;
2074 bool frameQueued = false;
2076 // Store the set of layers that need updates. This set must not change as
2077 // buffers are being latched, as this could result in a deadlock.
2078 // Example: Two producers share the same command stream and:
2079 // 1.) Layer 0 is latched
2080 // 2.) Layer 0 gets a new frame
2081 // 2.) Layer 1 gets a new frame
2082 // 3.) Layer 1 is latched.
2083 // Display is now waiting on Layer 1's frame, which is behind layer 0's
2084 // second frame. But layer 0's second frame could be waiting on display.
2085 Vector<Layer*> layersWithQueuedFrames;
2086 mDrawingState.traverseInZOrder([&](Layer* layer) {
2087 if (layer->hasQueuedFrame()) {
2089 if (layer->shouldPresentNow(mPrimaryDispSync)) {
2090 layersWithQueuedFrames.push_back(layer);
2092 layer->useEmptyDamage();
2095 layer->useEmptyDamage();
2098 for (size_t i = 0, count = layersWithQueuedFrames.size() ; i<count ; i++) {
2099 Layer* layer = layersWithQueuedFrames[i];
2100 const Region dirty(layer->latchBuffer(visibleRegions, latchTime));
2101 layer->useSurfaceDamage();
2102 invalidateLayerStack(layer->getLayerStack(), dirty);
2105 mVisibleRegionsDirty |= visibleRegions;
2107 // If we will need to wake up at some time in the future to deal with a
2108 // queued frame that shouldn't be displayed during this vsync period, wake
2109 // up during the next vsync period to check again.
2110 if (frameQueued && layersWithQueuedFrames.empty()) {
2111 signalLayerUpdate();
2114 // Only continue with the refresh if there is actually new work to do
2115 return !layersWithQueuedFrames.empty();
2118 void SurfaceFlinger::invalidateHwcGeometry()
2120 mHwWorkListDirty = true;
2124 void SurfaceFlinger::doDisplayComposition(const sp<const DisplayDevice>& hw,
2125 const Region& inDirtyRegion)
2127 // We only need to actually compose the display if:
2128 // 1) It is being handled by hardware composer, which may need this to
2129 // keep its virtual display state machine in sync, or
2130 // 2) There is work to be done (the dirty region isn't empty)
2131 bool isHwcDisplay = hw->getHwcDisplayId() >= 0;
2132 if (!isHwcDisplay && inDirtyRegion.isEmpty()) {
2136 Region dirtyRegion(inDirtyRegion);
2138 // compute the invalid region
2139 hw->swapRegion.orSelf(dirtyRegion);
2141 uint32_t flags = hw->getFlags();
2142 if (flags & DisplayDevice::SWAP_RECTANGLE) {
2143 // we can redraw only what's dirty, but since SWAP_RECTANGLE only
2144 // takes a rectangle, we must make sure to update that whole
2145 // rectangle in that case
2146 dirtyRegion.set(hw->swapRegion.bounds());
2148 if (flags & DisplayDevice::PARTIAL_UPDATES) {
2149 // We need to redraw the rectangle that will be updated
2150 // (pushed to the framebuffer).
2151 // This is needed because PARTIAL_UPDATES only takes one
2152 // rectangle instead of a region (see DisplayDevice::flip())
2153 dirtyRegion.set(hw->swapRegion.bounds());
2155 // we need to redraw everything (the whole screen)
2156 dirtyRegion.set(hw->bounds());
2157 hw->swapRegion = dirtyRegion;
2161 if (CC_LIKELY(!mDaltonize && !mHasColorMatrix)) {
2162 if (!doComposeSurfaces(hw, dirtyRegion)) return;
2164 RenderEngine& engine(getRenderEngine());
2165 mat4 colorMatrix = mColorMatrix;
2167 colorMatrix = colorMatrix * mDaltonizer();
2169 mat4 oldMatrix = engine.setupColorTransform(colorMatrix);
2170 doComposeSurfaces(hw, dirtyRegion);
2171 engine.setupColorTransform(oldMatrix);
2174 // update the swap region and clear the dirty region
2175 hw->swapRegion.orSelf(dirtyRegion);
2177 // swap buffers (presentation)
2178 hw->swapBuffers(getHwComposer());
2181 bool SurfaceFlinger::doComposeSurfaces(const sp<const DisplayDevice>& hw, const Region& dirty)
2183 RenderEngine& engine(getRenderEngine());
2184 const int32_t id = hw->getHwcDisplayId();
2185 HWComposer& hwc(getHwComposer());
2186 HWComposer::LayerListIterator cur = hwc.begin(id);
2187 const HWComposer::LayerListIterator end = hwc.end(id);
2189 bool hasGlesComposition = hwc.hasGlesComposition(id);
2190 if (hasGlesComposition) {
2191 if (!hw->makeCurrent(mEGLDisplay, mEGLContext)) {
2192 ALOGW("DisplayDevice::makeCurrent failed. Aborting surface composition for display %s",
2193 hw->getDisplayName().string());
2194 eglMakeCurrent(mEGLDisplay, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);
2195 if(!getDefaultDisplayDevice()->makeCurrent(mEGLDisplay, mEGLContext)) {
2196 ALOGE("DisplayDevice::makeCurrent on default display failed. Aborting.");
2201 // Never touch the framebuffer if we don't have any framebuffer layers
2202 const bool hasHwcComposition = hwc.hasHwcComposition(id);
2203 if (hasHwcComposition) {
2204 // when using overlays, we assume a fully transparent framebuffer
2205 // NOTE: we could reduce how much we need to clear, for instance
2206 // remove where there are opaque FB layers. however, on some
2207 // GPUs doing a "clean slate" clear might be more efficient.
2208 // We'll revisit later if needed.
2209 engine.clearWithColor(0, 0, 0, 0);
2211 // we start with the whole screen area
2212 const Region bounds(hw->getBounds());
2214 // we remove the scissor part
2215 // we're left with the letterbox region
2216 // (common case is that letterbox ends-up being empty)
2217 const Region letterbox(bounds.subtract(hw->getScissor()));
2219 // compute the area to clear
2220 Region region(hw->undefinedRegion.merge(letterbox));
2222 // but limit it to the dirty region
2223 region.andSelf(dirty);
2225 // screen is already cleared here
2226 if (!region.isEmpty()) {
2227 // can happen with SurfaceView
2228 drawWormhole(hw, region);
2232 if (hw->getDisplayType() != DisplayDevice::DISPLAY_PRIMARY) {
2233 // just to be on the safe side, we don't set the
2234 // scissor on the main display. It should never be needed
2235 // anyways (though in theory it could since the API allows it).
2236 const Rect& bounds(hw->getBounds());
2237 const Rect& scissor(hw->getScissor());
2238 if (scissor != bounds) {
2239 // scissor doesn't match the screen's dimensions, so we
2240 // need to clear everything outside of it and enable
2241 // the GL scissor so we don't draw anything where we shouldn't
2243 // enable scissor for this frame
2244 const uint32_t height = hw->getHeight();
2245 engine.setScissor(scissor.left, height - scissor.bottom,
2246 scissor.getWidth(), scissor.getHeight());
2252 * and then, render the layers targeted at the framebuffer
2255 const Vector< sp<Layer> >& layers(hw->getVisibleLayersSortedByZ());
2256 const size_t count = layers.size();
2257 const Transform& tr = hw->getTransform();
2259 // we're using h/w composer
2260 for (size_t i=0 ; i<count && cur!=end ; ++i, ++cur) {
2261 const sp<Layer>& layer(layers[i]);
2262 const Region clip(dirty.intersect(tr.transform(layer->visibleRegion)));
2263 if (!clip.isEmpty()) {
2264 switch (cur->getCompositionType()) {
2265 case HWC_CURSOR_OVERLAY:
2267 const Layer::State& state(layer->getDrawingState());
2268 if ((cur->getHints() & HWC_HINT_CLEAR_FB)
2270 && layer->isOpaque(state) && (state.alpha == 0xFF)
2271 && hasGlesComposition) {
2272 // never clear the very first layer since we're
2273 // guaranteed the FB is already cleared
2274 layer->clearWithOpenGL(hw);
2278 case HWC_FRAMEBUFFER: {
2279 layer->draw(hw, clip);
2282 case HWC_FRAMEBUFFER_TARGET: {
2283 // this should not happen as the iterator shouldn't
2284 // let us get there.
2285 ALOGW("HWC_FRAMEBUFFER_TARGET found in hwc list (index=%zu)", i);
2290 layer->setAcquireFence(hw, *cur);
2293 // we're not using h/w composer
2294 for (size_t i=0 ; i<count ; ++i) {
2295 const sp<Layer>& layer(layers[i]);
2296 const Region clip(dirty.intersect(
2297 tr.transform(layer->visibleRegion)));
2298 if (!clip.isEmpty()) {
2299 layer->draw(hw, clip);
2304 // disable scissor at the end of the frame
2305 engine.disableScissor();
2309 void SurfaceFlinger::drawWormhole(const sp<const DisplayDevice>& hw, const Region& region) const {
2310 const int32_t height = hw->getHeight();
2311 RenderEngine& engine(getRenderEngine());
2312 engine.fillRegionWithColor(region, height, 0, 0, 0, 0);
2315 status_t SurfaceFlinger::addClientLayer(const sp<Client>& client,
2316 const sp<IBinder>& handle,
2317 const sp<IGraphicBufferProducer>& gbc,
2318 const sp<Layer>& lbc,
2319 const sp<Layer>& parent)
2321 // add this layer to the current state list
2323 Mutex::Autolock _l(mStateLock);
2324 if (mNumLayers >= MAX_LAYERS) {
2327 if (parent == nullptr) {
2328 mCurrentState.layersSortedByZ.add(lbc);
2330 if (mCurrentState.layersSortedByZ.indexOf(parent) < 0) {
2331 ALOGE("addClientLayer called with a removed parent");
2332 return NAME_NOT_FOUND;
2334 parent->addChild(lbc);
2337 mGraphicBufferProducerList.add(IInterface::asBinder(gbc));
2338 mLayersAdded = true;
2342 // attach this layer to the client
2343 client->attachLayer(handle, lbc);
2348 status_t SurfaceFlinger::removeLayer(const sp<Layer>& layer, bool topLevelOnly) {
2349 Mutex::Autolock _l(mStateLock);
2351 const auto& p = layer->getParent();
2358 sp<Layer> ancestor = p;
2359 while (ancestor->getParent() != nullptr) {
2360 ancestor = ancestor->getParent();
2362 if (mCurrentState.layersSortedByZ.indexOf(ancestor) < 0) {
2363 ALOGE("removeLayer called with a layer whose parent has been removed");
2364 return NAME_NOT_FOUND;
2367 index = p->removeChild(layer);
2369 index = mCurrentState.layersSortedByZ.remove(layer);
2372 // As a matter of normal operation, the LayerCleaner will produce a second
2373 // attempt to remove the surface. The Layer will be kept alive in mDrawingState
2374 // so we will succeed in promoting it, but it's already been removed
2375 // from mCurrentState. As long as we can find it in mDrawingState we have no problem
2376 // otherwise something has gone wrong and we are leaking the layer.
2377 if (index < 0 && mDrawingState.layersSortedByZ.indexOf(layer) < 0) {
2378 ALOGE("Failed to find layer (%s) in layer parent (%s).",
2379 layer->getName().string(),
2380 (p != nullptr) ? p->getName().string() : "no-parent");
2382 } else if (index < 0) {
2386 mLayersPendingRemoval.add(layer);
2387 mLayersRemoved = true;
2388 mNumLayers -= 1 + layer->getChildrenCount();
2389 setTransactionFlags(eTransactionNeeded);
2393 uint32_t SurfaceFlinger::peekTransactionFlags() {
2394 return android_atomic_release_load(&mTransactionFlags);
2397 uint32_t SurfaceFlinger::getTransactionFlags(uint32_t flags) {
2398 return android_atomic_and(~flags, &mTransactionFlags) & flags;
2401 uint32_t SurfaceFlinger::setTransactionFlags(uint32_t flags) {
2402 uint32_t old = android_atomic_or(flags, &mTransactionFlags);
2403 if ((old & flags)==0) { // wake the server up
2404 signalTransaction();
2409 void SurfaceFlinger::setTransactionState(
2410 const Vector<ComposerState>& state,
2411 const Vector<DisplayState>& displays,
2415 Mutex::Autolock _l(mStateLock);
2416 uint32_t transactionFlags = 0;
2418 if (flags & eAnimation) {
2419 // For window updates that are part of an animation we must wait for
2420 // previous animation "frames" to be handled.
2421 while (mAnimTransactionPending) {
2422 status_t err = mTransactionCV.waitRelative(mStateLock, s2ns(5));
2423 if (CC_UNLIKELY(err != NO_ERROR)) {
2424 // just in case something goes wrong in SF, return to the
2425 // caller after a few seconds.
2426 ALOGW_IF(err == TIMED_OUT, "setTransactionState timed out "
2427 "waiting for previous animation frame");
2428 mAnimTransactionPending = false;
2434 size_t count = displays.size();
2435 for (size_t i=0 ; i<count ; i++) {
2436 const DisplayState& s(displays[i]);
2437 transactionFlags |= setDisplayStateLocked(s);
2440 count = state.size();
2441 for (size_t i=0 ; i<count ; i++) {
2442 const ComposerState& s(state[i]);
2443 // Here we need to check that the interface we're given is indeed
2444 // one of our own. A malicious client could give us a NULL
2445 // IInterface, or one of its own or even one of our own but a
2446 // different type. All these situations would cause us to crash.
2448 // NOTE: it would be better to use RTTI as we could directly check
2449 // that we have a Client*. however, RTTI is disabled in Android.
2450 if (s.client != NULL) {
2451 sp<IBinder> binder = IInterface::asBinder(s.client);
2452 if (binder != NULL) {
2453 if (binder->queryLocalInterface(ISurfaceComposerClient::descriptor) != NULL) {
2454 sp<Client> client( static_cast<Client *>(s.client.get()) );
2455 transactionFlags |= setClientStateLocked(client, s.state);
2461 // If a synchronous transaction is explicitly requested without any changes,
2462 // force a transaction anyway. This can be used as a flush mechanism for
2463 // previous async transactions.
2464 if (transactionFlags == 0 && (flags & eSynchronous)) {
2465 transactionFlags = eTransactionNeeded;
2468 if (transactionFlags) {
2469 if (mInterceptor.isEnabled()) {
2470 mInterceptor.saveTransaction(state, mCurrentState.displays, displays, flags);
2473 // this triggers the transaction
2474 setTransactionFlags(transactionFlags);
2476 // if this is a synchronous transaction, wait for it to take effect
2477 // before returning.
2478 if (flags & eSynchronous) {
2479 mTransactionPending = true;
2481 if (flags & eAnimation) {
2482 mAnimTransactionPending = true;
2484 while (mTransactionPending) {
2485 status_t err = mTransactionCV.waitRelative(mStateLock, s2ns(5));
2486 if (CC_UNLIKELY(err != NO_ERROR)) {
2487 // just in case something goes wrong in SF, return to the
2488 // called after a few seconds.
2489 ALOGW_IF(err == TIMED_OUT, "setTransactionState timed out!");
2490 mTransactionPending = false;
2497 uint32_t SurfaceFlinger::setDisplayStateLocked(const DisplayState& s)
2499 ssize_t dpyIdx = mCurrentState.displays.indexOfKey(s.token);
2504 DisplayDeviceState& disp(mCurrentState.displays.editValueAt(dpyIdx));
2505 if (disp.isValid()) {
2506 const uint32_t what = s.what;
2507 if (what & DisplayState::eSurfaceChanged) {
2508 if (IInterface::asBinder(disp.surface) != IInterface::asBinder(s.surface)) {
2509 disp.surface = s.surface;
2510 flags |= eDisplayTransactionNeeded;
2513 if (what & DisplayState::eLayerStackChanged) {
2514 if (disp.layerStack != s.layerStack) {
2515 disp.layerStack = s.layerStack;
2516 flags |= eDisplayTransactionNeeded;
2519 if (what & DisplayState::eDisplayProjectionChanged) {
2520 if (disp.orientation != s.orientation) {
2521 disp.orientation = s.orientation;
2522 flags |= eDisplayTransactionNeeded;
2524 if (disp.frame != s.frame) {
2525 disp.frame = s.frame;
2526 flags |= eDisplayTransactionNeeded;
2528 if (disp.viewport != s.viewport) {
2529 disp.viewport = s.viewport;
2530 flags |= eDisplayTransactionNeeded;
2533 if (what & DisplayState::eDisplaySizeChanged) {
2534 if (disp.width != s.width) {
2535 disp.width = s.width;
2536 flags |= eDisplayTransactionNeeded;
2538 if (disp.height != s.height) {
2539 disp.height = s.height;
2540 flags |= eDisplayTransactionNeeded;
2547 uint32_t SurfaceFlinger::setClientStateLocked(
2548 const sp<Client>& client,
2549 const layer_state_t& s)
2552 sp<Layer> layer(client->getLayerUser(s.surface));
2554 const uint32_t what = s.what;
2555 bool geometryAppliesWithResize =
2556 what & layer_state_t::eGeometryAppliesWithResize;
2557 if (what & layer_state_t::ePositionChanged) {
2558 if (layer->setPosition(s.x, s.y, !geometryAppliesWithResize)) {
2559 flags |= eTraversalNeeded;
2562 if (what & layer_state_t::eLayerChanged) {
2563 // NOTE: index needs to be calculated before we update the state
2564 const auto& p = layer->getParent();
2566 ssize_t idx = mCurrentState.layersSortedByZ.indexOf(layer);
2567 if (layer->setLayer(s.z) && idx >= 0) {
2568 mCurrentState.layersSortedByZ.removeAt(idx);
2569 mCurrentState.layersSortedByZ.add(layer);
2570 // we need traversal (state changed)
2571 // AND transaction (list changed)
2572 flags |= eTransactionNeeded|eTraversalNeeded;
2575 if (p->setChildLayer(layer, s.z)) {
2576 flags |= eTransactionNeeded|eTraversalNeeded;
2580 if (what & layer_state_t::eSizeChanged) {
2581 if (layer->setSize(s.w, s.h)) {
2582 flags |= eTraversalNeeded;
2585 if (what & layer_state_t::eAlphaChanged) {
2586 if (layer->setAlpha(uint8_t(255.0f*s.alpha+0.5f)))
2587 flags |= eTraversalNeeded;
2589 if (what & layer_state_t::eMatrixChanged) {
2590 if (layer->setMatrix(s.matrix))
2591 flags |= eTraversalNeeded;
2593 if (what & layer_state_t::eTransparentRegionChanged) {
2594 if (layer->setTransparentRegionHint(s.transparentRegion))
2595 flags |= eTraversalNeeded;
2597 if (what & layer_state_t::eFlagsChanged) {
2598 if (layer->setFlags(s.flags, s.mask))
2599 flags |= eTraversalNeeded;
2601 if (what & layer_state_t::eCropChanged) {
2602 if (layer->setCrop(s.crop, !geometryAppliesWithResize))
2603 flags |= eTraversalNeeded;
2605 if (what & layer_state_t::eFinalCropChanged) {
2606 if (layer->setFinalCrop(s.finalCrop, !geometryAppliesWithResize))
2607 flags |= eTraversalNeeded;
2609 if (what & layer_state_t::eLayerStackChanged) {
2610 ssize_t idx = mCurrentState.layersSortedByZ.indexOf(layer);
2611 // We only allow setting layer stacks for top level layers,
2612 // everything else inherits layer stack from its parent.
2613 if (layer->hasParent()) {
2614 ALOGE("Attempt to set layer stack on layer with parent (%s) is invalid",
2615 layer->getName().string());
2616 } else if (idx < 0) {
2617 ALOGE("Attempt to set layer stack on layer without parent (%s) that "
2618 "that also does not appear in the top level layer list. Something"
2619 " has gone wrong.", layer->getName().string());
2620 } else if (layer->setLayerStack(s.layerStack)) {
2621 mCurrentState.layersSortedByZ.removeAt(idx);
2622 mCurrentState.layersSortedByZ.add(layer);
2623 // we need traversal (state changed)
2624 // AND transaction (list changed)
2625 flags |= eTransactionNeeded|eTraversalNeeded;
2628 if (what & layer_state_t::eDeferTransaction) {
2629 if (s.barrierHandle != nullptr) {
2630 layer->deferTransactionUntil(s.barrierHandle, s.frameNumber);
2631 } else if (s.barrierGbp != nullptr) {
2632 const sp<IGraphicBufferProducer>& gbp = s.barrierGbp;
2633 if (authenticateSurfaceTextureLocked(gbp)) {
2634 const auto& otherLayer =
2635 (static_cast<MonitoredProducer*>(gbp.get()))->getLayer();
2636 layer->deferTransactionUntil(otherLayer, s.frameNumber);
2638 ALOGE("Attempt to defer transaction to to an"
2639 " unrecognized GraphicBufferProducer");
2642 // We don't trigger a traversal here because if no other state is
2643 // changed, we don't want this to cause any more work
2645 if (what & layer_state_t::eReparentChildren) {
2646 if (layer->reparentChildren(s.reparentHandle)) {
2647 flags |= eTransactionNeeded|eTraversalNeeded;
2650 if (what & layer_state_t::eDetachChildren) {
2651 layer->detachChildren();
2653 if (what & layer_state_t::eOverrideScalingModeChanged) {
2654 layer->setOverrideScalingMode(s.overrideScalingMode);
2655 // We don't trigger a traversal here because if no other state is
2656 // changed, we don't want this to cause any more work
2662 status_t SurfaceFlinger::createLayer(
2663 const String8& name,
2664 const sp<Client>& client,
2665 uint32_t w, uint32_t h, PixelFormat format, uint32_t flags,
2666 uint32_t windowType, uint32_t ownerUid, sp<IBinder>* handle,
2667 sp<IGraphicBufferProducer>* gbp, sp<Layer>* parent)
2669 if (int32_t(w|h) < 0) {
2670 ALOGE("createLayer() failed, w or h is negative (w=%d, h=%d)",
2675 status_t result = NO_ERROR;
2679 String8 uniqueName = getUniqueLayerName(name);
2681 switch (flags & ISurfaceComposerClient::eFXSurfaceMask) {
2682 case ISurfaceComposerClient::eFXSurfaceNormal:
2683 result = createNormalLayer(client,
2684 uniqueName, w, h, flags, format,
2685 handle, gbp, &layer);
2687 case ISurfaceComposerClient::eFXSurfaceDim:
2688 result = createDimLayer(client,
2689 uniqueName, w, h, flags,
2690 handle, gbp, &layer);
2697 if (result != NO_ERROR) {
2701 layer->setInfo(windowType, ownerUid);
2703 result = addClientLayer(client, *handle, *gbp, layer, *parent);
2704 if (result != NO_ERROR) {
2707 mInterceptor.saveSurfaceCreation(layer);
2709 setTransactionFlags(eTransactionNeeded);
2713 String8 SurfaceFlinger::getUniqueLayerName(const String8& name)
2715 bool matchFound = true;
2716 uint32_t dupeCounter = 0;
2718 // Tack on our counter whether there is a hit or not, so everyone gets a tag
2719 String8 uniqueName = name + "#" + String8(std::to_string(dupeCounter).c_str());
2721 // Loop over layers until we're sure there is no matching name
2722 while (matchFound) {
2724 mDrawingState.traverseInZOrder([&](Layer* layer) {
2725 if (layer->getName() == uniqueName) {
2727 uniqueName = name + "#" + String8(std::to_string(++dupeCounter).c_str());
2732 ALOGD_IF(dupeCounter > 0, "duplicate layer name: changing %s to %s", name.c_str(), uniqueName.c_str());
2737 status_t SurfaceFlinger::createNormalLayer(const sp<Client>& client,
2738 const String8& name, uint32_t w, uint32_t h, uint32_t flags, PixelFormat& format,
2739 sp<IBinder>* handle, sp<IGraphicBufferProducer>* gbp, sp<Layer>* outLayer)
2741 // initialize the surfaces
2743 case PIXEL_FORMAT_TRANSPARENT:
2744 case PIXEL_FORMAT_TRANSLUCENT:
2745 format = PIXEL_FORMAT_RGBA_8888;
2747 case PIXEL_FORMAT_OPAQUE:
2748 format = PIXEL_FORMAT_RGBX_8888;
2752 *outLayer = new Layer(this, client, name, w, h, flags);
2753 status_t err = (*outLayer)->setBuffers(w, h, format, flags);
2754 if (err == NO_ERROR) {
2755 *handle = (*outLayer)->getHandle();
2756 *gbp = (*outLayer)->getProducer();
2759 ALOGE_IF(err, "createNormalLayer() failed (%s)", strerror(-err));
2763 status_t SurfaceFlinger::createDimLayer(const sp<Client>& client,
2764 const String8& name, uint32_t w, uint32_t h, uint32_t flags,
2765 sp<IBinder>* handle, sp<IGraphicBufferProducer>* gbp, sp<Layer>* outLayer)
2767 *outLayer = new LayerDim(this, client, name, w, h, flags);
2768 *handle = (*outLayer)->getHandle();
2769 *gbp = (*outLayer)->getProducer();
2773 status_t SurfaceFlinger::onLayerRemoved(const sp<Client>& client, const sp<IBinder>& handle)
2775 // called by a client when it wants to remove a Layer
2776 status_t err = NO_ERROR;
2777 sp<Layer> l(client->getLayerUser(handle));
2779 mInterceptor.saveSurfaceDeletion(l);
2780 err = removeLayer(l);
2781 ALOGE_IF(err<0 && err != NAME_NOT_FOUND,
2782 "error removing layer=%p (%s)", l.get(), strerror(-err));
2787 status_t SurfaceFlinger::onLayerDestroyed(const wp<Layer>& layer)
2789 // called by ~LayerCleaner() when all references to the IBinder (handle)
2791 sp<Layer> l = layer.promote();
2793 // The layer has already been removed, carry on
2796 // If we have a parent, then we can continue to live as long as it does.
2797 return removeLayer(l, true);
2800 // ---------------------------------------------------------------------------
2802 void SurfaceFlinger::onInitializeDisplays() {
2803 // reset screen orientation and use primary layer stack
2804 Vector<ComposerState> state;
2805 Vector<DisplayState> displays;
2807 d.what = DisplayState::eDisplayProjectionChanged |
2808 DisplayState::eLayerStackChanged;
2809 d.token = mBuiltinDisplays[DisplayDevice::DISPLAY_PRIMARY];
2811 d.orientation = DisplayState::eOrientationDefault;
2812 d.frame.makeInvalid();
2813 d.viewport.makeInvalid();
2817 setTransactionState(state, displays, 0);
2818 setPowerModeInternal(getDisplayDevice(d.token), HWC_POWER_MODE_NORMAL);
2820 const nsecs_t period =
2821 getHwComposer().getRefreshPeriod(HWC_DISPLAY_PRIMARY);
2822 mAnimFrameTracker.setDisplayRefreshPeriod(period);
2824 // Use phase of 0 since phase is not known.
2825 // Use latency of 0, which will snap to the ideal latency.
2826 setCompositorTimingSnapped(0, period, 0);
2829 void SurfaceFlinger::initializeDisplays() {
2830 class MessageScreenInitialized : public MessageBase {
2831 SurfaceFlinger* flinger;
2833 explicit MessageScreenInitialized(SurfaceFlinger* flinger) : flinger(flinger) { }
2834 virtual bool handler() {
2835 flinger->onInitializeDisplays();
2839 sp<MessageBase> msg = new MessageScreenInitialized(this);
2840 postMessageAsync(msg); // we may be called from main thread, use async message
2843 void SurfaceFlinger::setPowerModeInternal(const sp<DisplayDevice>& hw,
2845 ALOGD("Set power mode=%d, type=%d flinger=%p", mode, hw->getDisplayType(),
2847 int32_t type = hw->getDisplayType();
2848 int currentMode = hw->getPowerMode();
2850 if (mode == currentMode) {
2851 ALOGD("Screen type=%d is already mode=%d", hw->getDisplayType(), mode);
2855 hw->setPowerMode(mode);
2856 if (type >= DisplayDevice::NUM_BUILTIN_DISPLAY_TYPES) {
2857 ALOGW("Trying to set power mode for virtual display");
2861 if (mInterceptor.isEnabled()) {
2862 Mutex::Autolock _l(mStateLock);
2863 ssize_t idx = mCurrentState.displays.indexOfKey(hw->getDisplayToken());
2865 ALOGW("Surface Interceptor SavePowerMode: invalid display token");
2868 mInterceptor.savePowerModeUpdate(mCurrentState.displays.valueAt(idx).displayId, mode);
2871 if (currentMode == HWC_POWER_MODE_OFF) {
2872 // Turn on the display
2873 getHwComposer().setPowerMode(type, mode);
2874 if (type == DisplayDevice::DISPLAY_PRIMARY &&
2875 mode != HWC_POWER_MODE_DOZE_SUSPEND) {
2876 // FIXME: eventthread only knows about the main display right now
2877 mEventThread->onScreenAcquired();
2878 resyncToHardwareVsync(true);
2881 mVisibleRegionsDirty = true;
2882 mHasPoweredOff = true;
2883 repaintEverything();
2885 struct sched_param param = {0};
2886 param.sched_priority = 1;
2887 if (sched_setscheduler(0, SCHED_FIFO, ¶m) != 0) {
2888 ALOGW("Couldn't set SCHED_FIFO on display on");
2890 } else if (mode == HWC_POWER_MODE_OFF) {
2891 // Turn off the display
2892 struct sched_param param = {0};
2893 if (sched_setscheduler(0, SCHED_OTHER, ¶m) != 0) {
2894 ALOGW("Couldn't set SCHED_OTHER on display off");
2897 if (type == DisplayDevice::DISPLAY_PRIMARY) {
2898 disableHardwareVsync(true); // also cancels any in-progress resync
2900 // FIXME: eventthread only knows about the main display right now
2901 mEventThread->onScreenReleased();
2904 getHwComposer().setPowerMode(type, mode);
2905 mVisibleRegionsDirty = true;
2906 // from this point on, SF will stop drawing on this display
2907 } else if (mode == HWC_POWER_MODE_DOZE ||
2908 mode == HWC_POWER_MODE_NORMAL) {
2909 // Update display while dozing
2910 getHwComposer().setPowerMode(type, mode);
2911 if (type == DisplayDevice::DISPLAY_PRIMARY) {
2912 // FIXME: eventthread only knows about the main display right now
2913 mEventThread->onScreenAcquired();
2914 resyncToHardwareVsync(true);
2916 } else if (mode == HWC_POWER_MODE_DOZE_SUSPEND) {
2917 // Leave display going to doze
2918 if (type == DisplayDevice::DISPLAY_PRIMARY) {
2919 disableHardwareVsync(true); // also cancels any in-progress resync
2920 // FIXME: eventthread only knows about the main display right now
2921 mEventThread->onScreenReleased();
2923 getHwComposer().setPowerMode(type, mode);
2925 ALOGE("Attempting to set unknown power mode: %d\n", mode);
2926 getHwComposer().setPowerMode(type, mode);
2930 void SurfaceFlinger::setPowerMode(const sp<IBinder>& display, int mode) {
2931 class MessageSetPowerMode: public MessageBase {
2932 SurfaceFlinger& mFlinger;
2933 sp<IBinder> mDisplay;
2936 MessageSetPowerMode(SurfaceFlinger& flinger,
2937 const sp<IBinder>& disp, int mode) : mFlinger(flinger),
2938 mDisplay(disp) { mMode = mode; }
2939 virtual bool handler() {
2940 sp<DisplayDevice> hw(mFlinger.getDisplayDevice(mDisplay));
2942 ALOGE("Attempt to set power mode = %d for null display %p",
2943 mMode, mDisplay.get());
2944 } else if (hw->getDisplayType() >= DisplayDevice::DISPLAY_VIRTUAL) {
2945 ALOGW("Attempt to set power mode = %d for virtual display",
2948 mFlinger.setPowerModeInternal(hw, mMode);
2953 sp<MessageBase> msg = new MessageSetPowerMode(*this, display, mode);
2954 postMessageSync(msg);
2957 // ---------------------------------------------------------------------------
2959 status_t SurfaceFlinger::dump(int fd, const Vector<String16>& args)
2963 IPCThreadState* ipc = IPCThreadState::self();
2964 const int pid = ipc->getCallingPid();
2965 const int uid = ipc->getCallingUid();
2966 if ((uid != AID_SHELL) &&
2967 !PermissionCache::checkPermission(sDump, pid, uid)) {
2968 result.appendFormat("Permission Denial: "
2969 "can't dump SurfaceFlinger from pid=%d, uid=%d\n", pid, uid);
2971 // Try to get the main lock, but give up after one second
2972 // (this would indicate SF is stuck, but we want to be able to
2973 // print something in dumpsys).
2974 status_t err = mStateLock.timedLock(s2ns(1));
2975 bool locked = (err == NO_ERROR);
2977 result.appendFormat(
2978 "SurfaceFlinger appears to be unresponsive (%s [%d]), "
2979 "dumping anyways (no locks held)\n", strerror(-err), err);
2982 bool dumpAll = true;
2984 size_t numArgs = args.size();
2986 if ((index < numArgs) &&
2987 (args[index] == String16("--list"))) {
2989 listLayersLocked(args, index, result);
2993 if ((index < numArgs) &&
2994 (args[index] == String16("--latency"))) {
2996 dumpStatsLocked(args, index, result);
3000 if ((index < numArgs) &&
3001 (args[index] == String16("--latency-clear"))) {
3003 clearStatsLocked(args, index, result);
3007 if ((index < numArgs) &&
3008 (args[index] == String16("--dispsync"))) {
3010 mPrimaryDispSync.dump(result);
3014 if ((index < numArgs) &&
3015 (args[index] == String16("--static-screen"))) {
3017 dumpStaticScreenStats(result);
3021 if ((index < numArgs) &&
3022 (args[index] == String16("--frame-events"))) {
3024 dumpFrameEventsLocked(result);
3030 dumpAllLocked(args, index, result);
3034 mStateLock.unlock();
3037 write(fd, result.string(), result.size());
3041 void SurfaceFlinger::listLayersLocked(const Vector<String16>& /* args */,
3042 size_t& /* index */, String8& result) const
3044 mCurrentState.traverseInZOrder([&](Layer* layer) {
3045 result.appendFormat("%s\n", layer->getName().string());
3049 void SurfaceFlinger::dumpStatsLocked(const Vector<String16>& args, size_t& index,
3050 String8& result) const
3053 if (index < args.size()) {
3054 name = String8(args[index]);
3058 const nsecs_t period =
3059 getHwComposer().getRefreshPeriod(HWC_DISPLAY_PRIMARY);
3060 result.appendFormat("%" PRId64 "\n", period);
3062 if (name.isEmpty()) {
3063 mAnimFrameTracker.dumpStats(result);
3065 mCurrentState.traverseInZOrder([&](Layer* layer) {
3066 if (name == layer->getName()) {
3067 layer->dumpFrameStats(result);
3073 void SurfaceFlinger::clearStatsLocked(const Vector<String16>& args, size_t& index,
3074 String8& /* result */)
3077 if (index < args.size()) {
3078 name = String8(args[index]);
3082 mCurrentState.traverseInZOrder([&](Layer* layer) {
3083 if (name.isEmpty() || (name == layer->getName())) {
3084 layer->clearFrameStats();
3088 mAnimFrameTracker.clearStats();
3091 // This should only be called from the main thread. Otherwise it would need
3092 // the lock and should use mCurrentState rather than mDrawingState.
3093 void SurfaceFlinger::logFrameStats() {
3094 mDrawingState.traverseInZOrder([&](Layer* layer) {
3095 layer->logFrameStats();
3098 mAnimFrameTracker.logAndResetStats(String8("<win-anim>"));
3101 void SurfaceFlinger::appendSfConfigString(String8& result) const
3103 result.append(" [sf");
3104 result.appendFormat(" HAS_CONTEXT_PRIORITY=%d", useContextPriority);
3106 if (isLayerTripleBufferingDisabled())
3107 result.append(" DISABLE_TRIPLE_BUFFERING");
3109 result.appendFormat(" PRESENT_TIME_OFFSET=%" PRId64, dispSyncPresentTimeOffset);
3110 result.appendFormat(" FORCE_HWC_FOR_RBG_TO_YUV=%d", useHwcForRgbToYuv);
3111 result.appendFormat(" MAX_VIRT_DISPLAY_DIM=%" PRIu64, maxVirtualDisplaySize);
3112 result.appendFormat(" RUNNING_WITHOUT_SYNC_FRAMEWORK=%d", !hasSyncFramework);
3113 result.appendFormat(" NUM_FRAMEBUFFER_SURFACE_BUFFERS=%" PRId64,
3114 maxFrameBufferAcquiredBuffers);
3118 void SurfaceFlinger::dumpStaticScreenStats(String8& result) const
3120 result.appendFormat("Static screen stats:\n");
3121 for (size_t b = 0; b < NUM_BUCKETS - 1; ++b) {
3122 float bucketTimeSec = mFrameBuckets[b] / 1e9;
3123 float percent = 100.0f *
3124 static_cast<float>(mFrameBuckets[b]) / mTotalTime;
3125 result.appendFormat(" < %zd frames: %.3f s (%.1f%%)\n",
3126 b + 1, bucketTimeSec, percent);
3128 float bucketTimeSec = mFrameBuckets[NUM_BUCKETS - 1] / 1e9;
3129 float percent = 100.0f *
3130 static_cast<float>(mFrameBuckets[NUM_BUCKETS - 1]) / mTotalTime;
3131 result.appendFormat(" %zd+ frames: %.3f s (%.1f%%)\n",
3132 NUM_BUCKETS - 1, bucketTimeSec, percent);
3135 void SurfaceFlinger::dumpFrameEventsLocked(String8& result) {
3136 result.appendFormat("Layer frame timestamps:\n");
3138 const LayerVector& currentLayers = mCurrentState.layersSortedByZ;
3139 const size_t count = currentLayers.size();
3140 for (size_t i=0 ; i<count ; i++) {
3141 currentLayers[i]->dumpFrameEvents(result);
3145 void SurfaceFlinger::recordBufferingStats(const char* layerName,
3146 std::vector<OccupancyTracker::Segment>&& history) {
3147 Mutex::Autolock lock(mBufferingStatsMutex);
3148 auto& stats = mBufferingStats[layerName];
3149 for (const auto& segment : history) {
3150 if (!segment.usedThirdBuffer) {
3151 stats.twoBufferTime += segment.totalTime;
3153 if (segment.occupancyAverage < 1.0f) {
3154 stats.doubleBufferedTime += segment.totalTime;
3155 } else if (segment.occupancyAverage < 2.0f) {
3156 stats.tripleBufferedTime += segment.totalTime;
3158 ++stats.numSegments;
3159 stats.totalTime += segment.totalTime;
3163 void SurfaceFlinger::dumpBufferingStats(String8& result) const {
3164 result.append("Buffering stats:\n");
3165 result.append(" [Layer name] <Active time> <Two buffer> "
3166 "<Double buffered> <Triple buffered>\n");
3167 Mutex::Autolock lock(mBufferingStatsMutex);
3168 typedef std::tuple<std::string, float, float, float> BufferTuple;
3169 std::map<float, BufferTuple, std::greater<float>> sorted;
3170 for (const auto& statsPair : mBufferingStats) {
3171 const char* name = statsPair.first.c_str();
3172 const BufferingStats& stats = statsPair.second;
3173 if (stats.numSegments == 0) {
3176 float activeTime = ns2ms(stats.totalTime) / 1000.0f;
3177 float twoBufferRatio = static_cast<float>(stats.twoBufferTime) /
3179 float doubleBufferRatio = static_cast<float>(
3180 stats.doubleBufferedTime) / stats.totalTime;
3181 float tripleBufferRatio = static_cast<float>(
3182 stats.tripleBufferedTime) / stats.totalTime;
3183 sorted.insert({activeTime, {name, twoBufferRatio,
3184 doubleBufferRatio, tripleBufferRatio}});
3186 for (const auto& sortedPair : sorted) {
3187 float activeTime = sortedPair.first;
3188 const BufferTuple& values = sortedPair.second;
3189 result.appendFormat(" [%s] %.2f %.3f %.3f %.3f\n",
3190 std::get<0>(values).c_str(), activeTime,
3191 std::get<1>(values), std::get<2>(values),
3192 std::get<3>(values));
3194 result.append("\n");
3197 void SurfaceFlinger::dumpAllLocked(const Vector<String16>& args, size_t& index,
3198 String8& result) const
3200 bool colorize = false;
3201 if (index < args.size()
3202 && (args[index] == String16("--color"))) {
3207 Colorizer colorizer(colorize);
3209 // figure out if we're stuck somewhere
3210 const nsecs_t now = systemTime();
3211 const nsecs_t inSwapBuffers(mDebugInSwapBuffers);
3212 const nsecs_t inTransaction(mDebugInTransaction);
3213 nsecs_t inSwapBuffersDuration = (inSwapBuffers) ? now-inSwapBuffers : 0;
3214 nsecs_t inTransactionDuration = (inTransaction) ? now-inTransaction : 0;
3217 * Dump library configuration.
3220 colorizer.bold(result);
3221 result.append("Build configuration:");
3222 colorizer.reset(result);
3223 appendSfConfigString(result);
3224 appendUiConfigString(result);
3225 appendGuiConfigString(result);
3226 result.append("\n");
3228 colorizer.bold(result);
3229 result.append("Sync configuration: ");
3230 colorizer.reset(result);
3231 result.append(SyncFeatures::getInstance().toString());
3232 result.append("\n");
3234 colorizer.bold(result);
3235 result.append("DispSync configuration: ");
3236 colorizer.reset(result);
3237 result.appendFormat("app phase %" PRId64 " ns, sf phase %" PRId64 " ns, "
3238 "present offset %" PRId64 " ns (refresh %" PRId64 " ns)",
3239 vsyncPhaseOffsetNs, sfVsyncPhaseOffsetNs, dispSyncPresentTimeOffset,
3240 mHwc->getRefreshPeriod(HWC_DISPLAY_PRIMARY));
3241 result.append("\n");
3243 // Dump static screen stats
3244 result.append("\n");
3245 dumpStaticScreenStats(result);
3246 result.append("\n");
3248 dumpBufferingStats(result);
3251 * Dump the visible layer list
3253 colorizer.bold(result);
3254 result.appendFormat("Visible layers (count = %zu)\n", mNumLayers);
3255 colorizer.reset(result);
3256 mCurrentState.traverseInZOrder([&](Layer* layer) {
3257 layer->dump(result, colorizer);
3261 * Dump Display state
3264 colorizer.bold(result);
3265 result.appendFormat("Displays (%zu entries)\n", mDisplays.size());
3266 colorizer.reset(result);
3267 for (size_t dpy=0 ; dpy<mDisplays.size() ; dpy++) {
3268 const sp<const DisplayDevice>& hw(mDisplays[dpy]);
3273 * Dump SurfaceFlinger global state
3276 colorizer.bold(result);
3277 result.append("SurfaceFlinger global state:\n");
3278 colorizer.reset(result);
3280 HWComposer& hwc(getHwComposer());
3281 sp<const DisplayDevice> hw(getDefaultDisplayDeviceLocked());
3283 colorizer.bold(result);
3284 result.appendFormat("EGL implementation : %s\n",
3285 eglQueryStringImplementationANDROID(mEGLDisplay, EGL_VERSION));
3286 colorizer.reset(result);
3287 result.appendFormat("%s\n",
3288 eglQueryStringImplementationANDROID(mEGLDisplay, EGL_EXTENSIONS));
3290 mRenderEngine->dump(result);
3292 hw->undefinedRegion.dump(result, "undefinedRegion");
3293 result.appendFormat(" orientation=%d, isDisplayOn=%d\n",
3294 hw->getOrientation(), hw->isDisplayOn());
3295 result.appendFormat(
3296 " last eglSwapBuffers() time: %f us\n"
3297 " last transaction time : %f us\n"
3298 " transaction-flags : %08x\n"
3299 " refresh-rate : %f fps\n"
3302 " gpu_to_cpu_unsupported : %d\n"
3304 mLastSwapBufferTime/1000.0,
3305 mLastTransactionTime/1000.0,
3307 1e9 / hwc.getRefreshPeriod(HWC_DISPLAY_PRIMARY),
3308 hwc.getDpiX(HWC_DISPLAY_PRIMARY),
3309 hwc.getDpiY(HWC_DISPLAY_PRIMARY),
3310 !mGpuToCpuSupported);
3312 result.appendFormat(" eglSwapBuffers time: %f us\n",
3313 inSwapBuffersDuration/1000.0);
3315 result.appendFormat(" transaction time: %f us\n",
3316 inTransactionDuration/1000.0);
3321 mEventThread->dump(result);
3324 * Dump HWComposer state
3326 colorizer.bold(result);
3327 result.append("h/w composer state:\n");
3328 colorizer.reset(result);
3329 result.appendFormat(" h/w composer %s and %s\n",
3330 hwc.initCheck()==NO_ERROR ? "present" : "not present",
3331 (mDebugDisableHWC || mDebugRegion || mDaltonize
3332 || mHasColorMatrix) ? "disabled" : "enabled");
3336 * Dump gralloc state
3338 const GraphicBufferAllocator& alloc(GraphicBufferAllocator::get());
3342 const Vector< sp<Layer> >&
3343 SurfaceFlinger::getLayerSortedByZForHwcDisplay(int id) {
3344 // Note: mStateLock is held here
3346 for (size_t i=0 ; i<mDisplays.size() ; i++) {
3347 if (mDisplays.valueAt(i)->getHwcDisplayId() == id) {
3348 dpy = mDisplays.keyAt(i);
3353 ALOGE("getLayerSortedByZForHwcDisplay: invalid hwc display id %d", id);
3354 // Just use the primary display so we have something to return
3355 dpy = getBuiltInDisplay(DisplayDevice::DISPLAY_PRIMARY);
3357 return getDisplayDeviceLocked(dpy)->getVisibleLayersSortedByZ();
3360 bool SurfaceFlinger::startDdmConnection()
3362 void* libddmconnection_dso =
3363 dlopen("libsurfaceflinger_ddmconnection.so", RTLD_NOW);
3364 if (!libddmconnection_dso) {
3367 void (*DdmConnection_start)(const char* name);
3368 DdmConnection_start =
3369 (decltype(DdmConnection_start))dlsym(libddmconnection_dso, "DdmConnection_start");
3370 if (!DdmConnection_start) {
3371 dlclose(libddmconnection_dso);
3374 (*DdmConnection_start)(getServiceName());
3378 status_t SurfaceFlinger::onTransact(
3379 uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags)
3382 case CREATE_CONNECTION:
3383 case CREATE_DISPLAY:
3385 case CLEAR_ANIMATION_FRAME_STATS:
3386 case GET_ANIMATION_FRAME_STATS:
3387 case SET_POWER_MODE:
3388 case GET_HDR_CAPABILITIES:
3390 // codes that require permission check
3391 IPCThreadState* ipc = IPCThreadState::self();
3392 const int pid = ipc->getCallingPid();
3393 const int uid = ipc->getCallingUid();
3394 if ((uid != AID_GRAPHICS && uid != AID_SYSTEM) &&
3395 !PermissionCache::checkPermission(sAccessSurfaceFlinger, pid, uid)) {
3396 ALOGE("Permission Denial: "
3397 "can't access SurfaceFlinger pid=%d, uid=%d", pid, uid);
3398 return PERMISSION_DENIED;
3403 * Calling setTransactionState is safe, because you need to have been
3404 * granted a reference to Client* and Handle* to do anything with it.
3406 * Creating a scoped connection is safe, as per discussion in ISurfaceComposer.h
3408 case SET_TRANSACTION_STATE:
3409 case CREATE_SCOPED_CONNECTION:
3413 case CAPTURE_SCREEN:
3415 // codes that require permission check
3416 IPCThreadState* ipc = IPCThreadState::self();
3417 const int pid = ipc->getCallingPid();
3418 const int uid = ipc->getCallingUid();
3419 if ((uid != AID_GRAPHICS) &&
3420 !PermissionCache::checkPermission(sReadFramebuffer, pid, uid)) {
3421 ALOGE("Permission Denial: "
3422 "can't read framebuffer pid=%d, uid=%d", pid, uid);
3423 return PERMISSION_DENIED;
3429 status_t err = BnSurfaceComposer::onTransact(code, data, reply, flags);
3430 if (err == UNKNOWN_TRANSACTION || err == PERMISSION_DENIED) {
3431 CHECK_INTERFACE(ISurfaceComposer, data, reply);
3432 if (CC_UNLIKELY(!PermissionCache::checkCallingPermission(sHardwareTest))) {
3433 IPCThreadState* ipc = IPCThreadState::self();
3434 const int pid = ipc->getCallingPid();
3435 const int uid = ipc->getCallingUid();
3436 ALOGE("Permission Denial: "
3437 "can't access SurfaceFlinger pid=%d, uid=%d", pid, uid);
3438 return PERMISSION_DENIED;
3442 case 1000: // SHOW_CPU, NOT SUPPORTED ANYMORE
3443 case 1001: // SHOW_FPS, NOT SUPPORTED ANYMORE
3445 case 1002: // SHOW_UPDATES
3446 n = data.readInt32();
3447 mDebugRegion = n ? n : (mDebugRegion ? 0 : 1);
3448 invalidateHwcGeometry();
3449 repaintEverything();
3451 case 1004:{ // repaint everything
3452 repaintEverything();
3455 case 1005:{ // force transaction
3456 setTransactionFlags(
3458 eDisplayTransactionNeeded|
3462 case 1006:{ // send empty update
3466 case 1008: // toggle use of hw composer
3467 n = data.readInt32();
3468 mDebugDisableHWC = n ? 1 : 0;
3469 invalidateHwcGeometry();
3470 repaintEverything();
3472 case 1009: // toggle use of transform hint
3473 n = data.readInt32();
3474 mDebugDisableTransformHint = n ? 1 : 0;
3475 invalidateHwcGeometry();
3476 repaintEverything();
3478 case 1010: // interrogate.
3479 reply->writeInt32(0);
3480 reply->writeInt32(0);
3481 reply->writeInt32(mDebugRegion);
3482 reply->writeInt32(0);
3483 reply->writeInt32(mDebugDisableHWC);
3486 Mutex::Autolock _l(mStateLock);
3487 sp<const DisplayDevice> hw(getDefaultDisplayDevice());
3488 reply->writeInt32(hw->getPageFlipCount());
3493 n = data.readInt32();
3496 mDaltonizer.setType(ColorBlindnessType::Protanomaly);
3499 mDaltonizer.setType(ColorBlindnessType::Deuteranomaly);
3502 mDaltonizer.setType(ColorBlindnessType::Tritanomaly);
3506 mDaltonizer.setMode(ColorBlindnessMode::Correction);
3508 mDaltonizer.setMode(ColorBlindnessMode::Simulation);
3511 invalidateHwcGeometry();
3512 repaintEverything();
3516 // apply a color matrix
3517 n = data.readInt32();
3518 mHasColorMatrix = n ? 1 : 0;
3520 // color matrix is sent as mat3 matrix followed by vec3
3521 // offset, then packed into a mat4 where the last row is
3522 // the offset and extra values are 0
3523 for (size_t i = 0 ; i < 4; i++) {
3524 for (size_t j = 0; j < 4; j++) {
3525 mColorMatrix[i][j] = data.readFloat();
3529 mColorMatrix = mat4();
3531 invalidateHwcGeometry();
3532 repaintEverything();
3535 // This is an experimental interface
3536 // Needs to be shifted to proper binder interface when we productize
3538 n = data.readInt32();
3539 mPrimaryDispSync.setRefreshSkipCount(n);
3543 n = data.readInt32();
3544 mForceFullDamage = static_cast<bool>(n);
3547 case 1018: { // Modify Choreographer's phase offset
3548 n = data.readInt32();
3549 mEventThread->setPhaseOffset(static_cast<nsecs_t>(n));
3552 case 1019: { // Modify SurfaceFlinger's phase offset
3553 n = data.readInt32();
3554 mSFEventThread->setPhaseOffset(static_cast<nsecs_t>(n));
3557 case 1020: { // Layer updates interceptor
3558 n = data.readInt32();
3560 ALOGV("Interceptor enabled");
3561 mInterceptor.enable(mDrawingState.layersSortedByZ, mDrawingState.displays);
3564 ALOGV("Interceptor disabled");
3565 mInterceptor.disable();
3569 case 1021: { // Disable HWC virtual displays
3570 n = data.readInt32();
3571 mUseHwcVirtualDisplays = !n;
3579 void SurfaceFlinger::repaintEverything() {
3580 android_atomic_or(1, &mRepaintEverything);
3581 signalTransaction();
3584 // ---------------------------------------------------------------------------
3585 // Capture screen into an IGraphiBufferProducer
3586 // ---------------------------------------------------------------------------
3588 /* The code below is here to handle b/8734824
3590 * We create a IGraphicBufferProducer wrapper that forwards all calls
3591 * from the surfaceflinger thread to the calling binder thread, where they
3592 * are executed. This allows the calling thread in the calling process to be
3593 * reused and not depend on having "enough" binder threads to handle the
3596 class GraphicProducerWrapper : public BBinder, public MessageHandler {
3597 /* Parts of GraphicProducerWrapper are run on two different threads,
3598 * communicating by sending messages via Looper but also by shared member
3599 * data. Coherence maintenance is subtle and in places implicit (ugh).
3601 * Don't rely on Looper's sendMessage/handleMessage providing
3602 * release/acquire semantics for any data not actually in the Message.
3603 * Data going from surfaceflinger to binder threads needs to be
3604 * synchronized explicitly.
3606 * Barrier open/wait do provide release/acquire semantics. This provides
3607 * implicit synchronization for data coming back from binder to
3608 * surfaceflinger threads.
3611 sp<IGraphicBufferProducer> impl;
3627 * Called on surfaceflinger thread. This is called by our "fake"
3628 * BpGraphicBufferProducer. We package the data and reply Parcel and
3629 * forward them to the binder thread.
3631 virtual status_t transact(uint32_t code,
3632 const Parcel& data, Parcel* reply, uint32_t /* flags */) {
3635 this->reply = reply;
3637 // if we've exited, we run the message synchronously right here.
3638 // note (JH): as far as I can tell from looking at the code, this
3639 // never actually happens. if it does, i'm not sure if it happens
3640 // on the surfaceflinger or binder thread.
3641 handleMessage(Message(MSG_API_CALL));
3644 // Prevent stores to this->{code, data, reply} from being
3645 // reordered later than the construction of Message.
3646 atomic_thread_fence(memory_order_release);
3647 looper->sendMessage(this, Message(MSG_API_CALL));
3654 * here we run on the binder thread. All we've got to do is
3655 * call the real BpGraphicBufferProducer.
3657 virtual void handleMessage(const Message& message) {
3658 int what = message.what;
3659 // Prevent reads below from happening before the read from Message
3660 atomic_thread_fence(memory_order_acquire);
3661 if (what == MSG_API_CALL) {
3662 result = IInterface::asBinder(impl)->transact(code, data[0], reply);
3664 } else if (what == MSG_EXIT) {
3665 exitRequested = true;
3670 explicit GraphicProducerWrapper(const sp<IGraphicBufferProducer>& impl)
3672 looper(new Looper(true)),
3675 exitRequested(false),
3682 status_t waitForResponse() {
3684 looper->pollOnce(-1);
3685 } while (!exitRequested);
3690 void exit(status_t result) {
3691 this->result = result;
3693 // Ensure this->result is visible to the binder thread before it
3694 // handles the message.
3695 atomic_thread_fence(memory_order_release);
3696 looper->sendMessage(this, Message(MSG_EXIT));
3701 status_t SurfaceFlinger::captureScreen(const sp<IBinder>& display,
3702 const sp<IGraphicBufferProducer>& producer,
3703 Rect sourceCrop, uint32_t reqWidth, uint32_t reqHeight,
3704 int32_t minLayerZ, int32_t maxLayerZ,
3705 bool useIdentityTransform, ISurfaceComposer::Rotation rotation) {
3707 if (CC_UNLIKELY(display == 0))
3710 if (CC_UNLIKELY(producer == 0))
3713 // if we have secure windows on this display, never allow the screen capture
3714 // unless the producer interface is local (i.e.: we can take a screenshot for
3716 bool isLocalScreenshot = IInterface::asBinder(producer)->localBinder();
3718 // Convert to surfaceflinger's internal rotation type.
3719 Transform::orientation_flags rotationFlags;
3721 case ISurfaceComposer::eRotateNone:
3722 rotationFlags = Transform::ROT_0;
3724 case ISurfaceComposer::eRotate90:
3725 rotationFlags = Transform::ROT_90;
3727 case ISurfaceComposer::eRotate180:
3728 rotationFlags = Transform::ROT_180;
3730 case ISurfaceComposer::eRotate270:
3731 rotationFlags = Transform::ROT_270;
3734 rotationFlags = Transform::ROT_0;
3735 ALOGE("Invalid rotation passed to captureScreen(): %d\n", rotation);
3739 class MessageCaptureScreen : public MessageBase {
3740 SurfaceFlinger* flinger;
3741 sp<IBinder> display;
3742 sp<IGraphicBufferProducer> producer;
3744 uint32_t reqWidth, reqHeight;
3745 int32_t minLayerZ,maxLayerZ;
3746 bool useIdentityTransform;
3747 Transform::orientation_flags rotation;
3749 bool isLocalScreenshot;
3751 MessageCaptureScreen(SurfaceFlinger* flinger,
3752 const sp<IBinder>& display,
3753 const sp<IGraphicBufferProducer>& producer,
3754 Rect sourceCrop, uint32_t reqWidth, uint32_t reqHeight,
3755 int32_t minLayerZ, int32_t maxLayerZ,
3756 bool useIdentityTransform,
3757 Transform::orientation_flags rotation,
3758 bool isLocalScreenshot)
3759 : flinger(flinger), display(display), producer(producer),
3760 sourceCrop(sourceCrop), reqWidth(reqWidth), reqHeight(reqHeight),
3761 minLayerZ(minLayerZ), maxLayerZ(maxLayerZ),
3762 useIdentityTransform(useIdentityTransform),
3763 rotation(rotation), result(PERMISSION_DENIED),
3764 isLocalScreenshot(isLocalScreenshot)
3767 status_t getResult() const {
3770 virtual bool handler() {
3771 Mutex::Autolock _l(flinger->mStateLock);
3772 sp<const DisplayDevice> hw(flinger->getDisplayDeviceLocked(display));
3773 result = flinger->captureScreenImplLocked(hw, producer,
3774 sourceCrop, reqWidth, reqHeight, minLayerZ, maxLayerZ,
3775 useIdentityTransform, rotation, isLocalScreenshot);
3776 static_cast<GraphicProducerWrapper*>(IInterface::asBinder(producer).get())->exit(result);
3781 // this creates a "fake" BBinder which will serve as a "fake" remote
3782 // binder to receive the marshaled calls and forward them to the
3783 // real remote (a BpGraphicBufferProducer)
3784 sp<GraphicProducerWrapper> wrapper = new GraphicProducerWrapper(producer);
3786 // the asInterface() call below creates our "fake" BpGraphicBufferProducer
3787 // which does the marshaling work forwards to our "fake remote" above.
3788 sp<MessageBase> msg = new MessageCaptureScreen(this,
3789 display, IGraphicBufferProducer::asInterface( wrapper ),
3790 sourceCrop, reqWidth, reqHeight, minLayerZ, maxLayerZ,
3791 useIdentityTransform, rotationFlags, isLocalScreenshot);
3793 status_t res = postMessageAsync(msg);
3794 if (res == NO_ERROR) {
3795 res = wrapper->waitForResponse();
3801 void SurfaceFlinger::renderScreenImplLocked(
3802 const sp<const DisplayDevice>& hw,
3803 Rect sourceCrop, uint32_t reqWidth, uint32_t reqHeight,
3804 int32_t minLayerZ, int32_t maxLayerZ,
3805 bool yswap, bool useIdentityTransform, Transform::orientation_flags rotation)
3808 RenderEngine& engine(getRenderEngine());
3810 // get screen geometry
3811 const int32_t hw_w = hw->getWidth();
3812 const int32_t hw_h = hw->getHeight();
3813 const bool filtering = static_cast<int32_t>(reqWidth) != hw_w ||
3814 static_cast<int32_t>(reqHeight) != hw_h;
3816 // if a default or invalid sourceCrop is passed in, set reasonable values
3817 if (sourceCrop.width() == 0 || sourceCrop.height() == 0 ||
3818 !sourceCrop.isValid()) {
3819 sourceCrop.setLeftTop(Point(0, 0));
3820 sourceCrop.setRightBottom(Point(hw_w, hw_h));
3823 // ensure that sourceCrop is inside screen
3824 if (sourceCrop.left < 0) {
3825 ALOGE("Invalid crop rect: l = %d (< 0)", sourceCrop.left);
3827 if (sourceCrop.right > hw_w) {
3828 ALOGE("Invalid crop rect: r = %d (> %d)", sourceCrop.right, hw_w);
3830 if (sourceCrop.top < 0) {
3831 ALOGE("Invalid crop rect: t = %d (< 0)", sourceCrop.top);
3833 if (sourceCrop.bottom > hw_h) {
3834 ALOGE("Invalid crop rect: b = %d (> %d)", sourceCrop.bottom, hw_h);
3837 // make sure to clear all GL error flags
3838 engine.checkErrors();
3840 // set-up our viewport
3841 engine.setViewportAndProjection(
3842 reqWidth, reqHeight, sourceCrop, hw_h, yswap, rotation);
3843 engine.disableTexturing();
3845 // redraw the screen entirely...
3846 engine.clearWithColor(0, 0, 0, 1);
3848 // We loop through the first level of layers without traversing,
3849 // as we need to interpret min/max layer Z in the top level Z space.
3850 for (const auto& layer : mDrawingState.layersSortedByZ) {
3851 if (layer->getLayerStack() != hw->getLayerStack()) {
3854 const Layer::State& state(layer->getDrawingState());
3855 if (state.z < minLayerZ || state.z > maxLayerZ) {
3858 layer->traverseInZOrder(LayerVector::StateSet::Drawing, [&](Layer* layer) {
3859 if (!layer->isVisible()) {
3862 if (filtering) layer->setFiltering(true);
3863 layer->draw(hw, useIdentityTransform);
3864 if (filtering) layer->setFiltering(false);
3868 // compositionComplete is needed for older driver
3869 hw->compositionComplete();
3870 hw->setViewportAndProjection();
3874 status_t SurfaceFlinger::captureScreenImplLocked(
3875 const sp<const DisplayDevice>& hw,
3876 const sp<IGraphicBufferProducer>& producer,
3877 Rect sourceCrop, uint32_t reqWidth, uint32_t reqHeight,
3878 int32_t minLayerZ, int32_t maxLayerZ,
3879 bool useIdentityTransform, Transform::orientation_flags rotation,
3880 bool isLocalScreenshot)
3884 // get screen geometry
3885 uint32_t hw_w = hw->getWidth();
3886 uint32_t hw_h = hw->getHeight();
3888 if (rotation & Transform::ROT_90) {
3889 std::swap(hw_w, hw_h);
3892 if ((reqWidth > hw_w) || (reqHeight > hw_h)) {
3893 ALOGE("size mismatch (%d, %d) > (%d, %d)",
3894 reqWidth, reqHeight, hw_w, hw_h);
3898 reqWidth = (!reqWidth) ? hw_w : reqWidth;
3899 reqHeight = (!reqHeight) ? hw_h : reqHeight;
3901 bool secureLayerIsVisible = false;
3902 for (const auto& layer : mDrawingState.layersSortedByZ) {
3903 const Layer::State& state(layer->getDrawingState());
3904 if ((layer->getLayerStack() != hw->getLayerStack()) ||
3905 (state.z < minLayerZ || state.z > maxLayerZ)) {
3908 layer->traverseInZOrder(LayerVector::StateSet::Drawing, [&](Layer *layer) {
3909 secureLayerIsVisible = secureLayerIsVisible || (layer->isVisible() &&
3914 if (!isLocalScreenshot && secureLayerIsVisible) {
3915 ALOGW("FB is protected: PERMISSION_DENIED");
3916 return PERMISSION_DENIED;
3919 // create a surface (because we're a producer, and we need to
3920 // dequeue/queue a buffer)
3921 sp<Surface> sur = new Surface(producer, false);
3922 ANativeWindow* window = sur.get();
3924 status_t result = native_window_api_connect(window, NATIVE_WINDOW_API_EGL);
3925 if (result == NO_ERROR) {
3926 uint32_t usage = GRALLOC_USAGE_SW_READ_OFTEN | GRALLOC_USAGE_SW_WRITE_OFTEN |
3927 GRALLOC_USAGE_HW_RENDER | GRALLOC_USAGE_HW_TEXTURE;
3930 err = native_window_set_buffers_dimensions(window, reqWidth, reqHeight);
3931 err |= native_window_set_scaling_mode(window, NATIVE_WINDOW_SCALING_MODE_SCALE_TO_WINDOW);
3932 err |= native_window_set_buffers_format(window, HAL_PIXEL_FORMAT_RGBA_8888);
3933 err |= native_window_set_usage(window, usage);
3935 if (err == NO_ERROR) {
3936 ANativeWindowBuffer* buffer;
3937 /* TODO: Once we have the sync framework everywhere this can use
3938 * server-side waits on the fence that dequeueBuffer returns.
3940 result = native_window_dequeue_buffer_and_wait(window, &buffer);
3941 if (result == NO_ERROR) {
3943 // create an EGLImage from the buffer so we can later
3944 // turn it into a texture
3945 EGLImageKHR image = eglCreateImageKHR(mEGLDisplay, EGL_NO_CONTEXT,
3946 EGL_NATIVE_BUFFER_ANDROID, buffer, NULL);
3947 if (image != EGL_NO_IMAGE_KHR) {
3948 // this binds the given EGLImage as a framebuffer for the
3949 // duration of this scope.
3950 RenderEngine::BindImageAsFramebuffer imageBond(getRenderEngine(), image);
3951 if (imageBond.getStatus() == NO_ERROR) {
3952 // this will in fact render into our dequeued buffer
3953 // via an FBO, which means we didn't have to create
3954 // an EGLSurface and therefore we're not
3955 // dependent on the context's EGLConfig.
3956 renderScreenImplLocked(
3957 hw, sourceCrop, reqWidth, reqHeight, minLayerZ, maxLayerZ, true,
3958 useIdentityTransform, rotation);
3960 // Attempt to create a sync khr object that can produce a sync point. If that
3961 // isn't available, create a non-dupable sync object in the fallback path and
3962 // wait on it directly.
3964 if (!DEBUG_SCREENSHOTS) {
3965 sync = eglCreateSyncKHR(mEGLDisplay, EGL_SYNC_NATIVE_FENCE_ANDROID, NULL);
3966 // native fence fd will not be populated until flush() is done.
3967 getRenderEngine().flush();
3969 sync = EGL_NO_SYNC_KHR;
3971 if (sync != EGL_NO_SYNC_KHR) {
3973 syncFd = eglDupNativeFenceFDANDROID(mEGLDisplay, sync);
3974 if (syncFd == EGL_NO_NATIVE_FENCE_FD_ANDROID) {
3975 ALOGW("captureScreen: failed to dup sync khr object");
3978 eglDestroySyncKHR(mEGLDisplay, sync);
3981 sync = eglCreateSyncKHR(mEGLDisplay, EGL_SYNC_FENCE_KHR, NULL);
3982 if (sync != EGL_NO_SYNC_KHR) {
3983 EGLint result = eglClientWaitSyncKHR(mEGLDisplay, sync,
3984 EGL_SYNC_FLUSH_COMMANDS_BIT_KHR, 2000000000 /*2 sec*/);
3985 EGLint eglErr = eglGetError();
3986 if (result == EGL_TIMEOUT_EXPIRED_KHR) {
3987 ALOGW("captureScreen: fence wait timed out");
3989 ALOGW_IF(eglErr != EGL_SUCCESS,
3990 "captureScreen: error waiting on EGL fence: %#x", eglErr);
3992 eglDestroySyncKHR(mEGLDisplay, sync);
3994 ALOGW("captureScreen: error creating EGL fence: %#x", eglGetError());
3997 if (DEBUG_SCREENSHOTS) {
3998 uint32_t* pixels = new uint32_t[reqWidth*reqHeight];
3999 getRenderEngine().readPixels(0, 0, reqWidth, reqHeight, pixels);
4000 checkScreenshot(reqWidth, reqHeight, reqWidth, pixels,
4001 hw, minLayerZ, maxLayerZ);
4006 ALOGE("got GL_FRAMEBUFFER_COMPLETE_OES error while taking screenshot");
4007 result = INVALID_OPERATION;
4008 window->cancelBuffer(window, buffer, syncFd);
4011 // destroy our image
4012 eglDestroyImageKHR(mEGLDisplay, image);
4017 // queueBuffer takes ownership of syncFd
4018 result = window->queueBuffer(window, buffer, syncFd);
4024 native_window_api_disconnect(window, NATIVE_WINDOW_API_EGL);
4030 void SurfaceFlinger::checkScreenshot(size_t w, size_t s, size_t h, void const* vaddr,
4031 const sp<const DisplayDevice>& hw, int32_t minLayerZ, int32_t maxLayerZ) {
4032 if (DEBUG_SCREENSHOTS) {
4033 for (size_t y=0 ; y<h ; y++) {
4034 uint32_t const * p = (uint32_t const *)vaddr + y*s;
4035 for (size_t x=0 ; x<w ; x++) {
4036 if (p[x] != 0xFF000000) return;
4039 ALOGE("*** we just took a black screenshot ***\n"
4040 "requested minz=%d, maxz=%d, layerStack=%d",
4041 minLayerZ, maxLayerZ, hw->getLayerStack());
4043 for (const auto& layer : mDrawingState.layersSortedByZ) {
4044 const Layer::State& state(layer->getDrawingState());
4045 if (layer->getLayerStack() == hw->getLayerStack() && state.z >= minLayerZ &&
4046 state.z <= maxLayerZ) {
4047 layer->traverseInZOrder(LayerVector::StateSet::Drawing, [&](Layer* layer) {
4048 ALOGE("%c index=%zu, name=%s, layerStack=%d, z=%d, visible=%d, flags=%x, alpha=%x",
4049 layer->isVisible() ? '+' : '-',
4050 i, layer->getName().string(), layer->getLayerStack(), state.z,
4051 layer->isVisible(), state.flags, state.alpha);
4059 // ---------------------------------------------------------------------------
4061 void SurfaceFlinger::State::traverseInZOrder(const LayerVector::Visitor& visitor) const {
4062 layersSortedByZ.traverseInZOrder(stateSet, visitor);
4065 void SurfaceFlinger::State::traverseInReverseZOrder(const LayerVector::Visitor& visitor) const {
4066 layersSortedByZ.traverseInReverseZOrder(stateSet, visitor);
4069 }; // namespace android
4072 #if defined(__gl_h_)
4073 #error "don't include gl/gl.h in this file"
4076 #if defined(__gl2_h_)
4077 #error "don't include gl2/gl2.h in this file"