services/surfaceflinger/SurfaceFlinger.h

   1 /*
   2  * Copyright (C) 2007 The Android Open Source Project
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef ANDROID_SURFACE_FLINGER_H
  18 #define ANDROID_SURFACE_FLINGER_H
  19
  20 #include <memory>
  21 #include <stdint.h>
  22 #include <sys/types.h>
  23
  24 #include <EGL/egl.h>
  25
  26 /*
  27  * NOTE: Make sure this file doesn't include  anything from <gl/ > or <gl2/ >
  28  */
  29
  30 #include <cutils/compiler.h>
  31
  32 #include <utils/Atomic.h>
  33 #include <utils/Errors.h>
  34 #include <utils/KeyedVector.h>
  35 #include <utils/RefBase.h>
  36 #include <utils/SortedVector.h>
  37 #include <utils/threads.h>
  38
  39 #include <ui/FenceTime.h>
  40 #include <ui/PixelFormat.h>
  41 #include <math/mat4.h>
  42
  43 #include <gui/FrameTimestamps.h>
  44 #include <gui/ISurfaceComposer.h>
  45 #include <gui/ISurfaceComposerClient.h>
  46 #include <gui/OccupancyTracker.h>
  47
  48 #include <hardware/hwcomposer_defs.h>
  49
  50 #include <system/graphics.h>
  51
  52 #include <private/gui/LayerState.h>
  53
  54 #include "Barrier.h"
  55 #include "DisplayDevice.h"
  56 #include "DispSync.h"
  57 #include "FrameTracker.h"
  58 #include "LayerVector.h"
  59 #include "MessageQueue.h"
  60 #include "SurfaceInterceptor.h"
  61 #include "StartBootAnimThread.h"
  62
  63 #include "DisplayHardware/HWComposer.h"
  64 #include "Effects/Daltonizer.h"
  65
  66 #include <map>
  67 #include <mutex>
  68 #include <queue>
  69 #include <string>
  70 #include <utility>
  71
  72 namespace android {
  73
  74 // ---------------------------------------------------------------------------
  75
  76 class Client;
  77 class DisplayEventConnection;
  78 class EventThread;
  79 class Layer;
  80 class LayerDim;
  81 class Surface;
  82 class RenderEngine;
  83 class EventControlThread;
  84 class VSyncSource;
  85 class InjectVSyncSource;
  86
  87 namespace dvr {
  88 class VrFlinger;
  89 } // namespace dvr
  90
  91 // ---------------------------------------------------------------------------
  92
  93 enum {
  94     eTransactionNeeded        = 0x01,
  95     eTraversalNeeded          = 0x02,
  96     eDisplayTransactionNeeded = 0x04,
  97     eTransactionMask          = 0x07
  98 };
  99
 100 class SurfaceFlinger : public BnSurfaceComposer,
 101                        private IBinder::DeathRecipient,
 102                        private HWComposer::EventHandler
 103 {
 104 public:
 105
 106     // This is the phase offset in nanoseconds of the software vsync event
 107     // relative to the vsync event reported by HWComposer.  The software vsync
 108     // event is when SurfaceFlinger and Choreographer-based applications run each
 109     // frame.
 110     //
 111     // This phase offset allows adjustment of the minimum latency from application
 112     // wake-up time (by Choreographer) to the time at which the resulting window
 113     // image is displayed.  This value may be either positive (after the HW vsync)
 114     // or negative (before the HW vsync). Setting it to 0 will result in a lower
 115     // latency bound of two vsync periods because the app and SurfaceFlinger
 116     // will run just after the HW vsync.  Setting it to a positive number will
 117     // result in the minimum latency being:
 118     //
 119     //     (2 * VSYNC_PERIOD - (vsyncPhaseOffsetNs % VSYNC_PERIOD))
 120     //
 121     // Note that reducing this latency makes it more likely for the applications
 122     // to not have their window content image ready in time.  When this happens
 123     // the latency will end up being an additional vsync period, and animations
 124     // will hiccup.  Therefore, this latency should be tuned somewhat
 125     // conservatively (or at least with awareness of the trade-off being made).
 126     static int64_t vsyncPhaseOffsetNs;
 127     static int64_t sfVsyncPhaseOffsetNs;
 128
 129     // If fences from sync Framework are supported.
 130     static bool hasSyncFramework;
 131
 132     // Instruct the Render Engine to use EGL_IMG_context_priority is available.
 133     static bool useContextPriority;
 134
 135     // The offset in nanoseconds to use when DispSync timestamps present fence
 136     // signaling time.
 137     static int64_t dispSyncPresentTimeOffset;
 138
 139     // Some hardware can do RGB->YUV conversion more efficiently in hardware
 140     // controlled by HWC than in hardware controlled by the video encoder.
 141     // This instruct VirtualDisplaySurface to use HWC for such conversion on
 142     // GL composition.
 143     static bool useHwcForRgbToYuv;
 144
 145     // Maximum dimension supported by HWC for virtual display.
 146     // Equal to min(max_height, max_width).
 147     static uint64_t maxVirtualDisplaySize;
 148
 149     // Controls the number of buffers SurfaceFlinger will allocate for use in
 150     // FramebufferSurface
 151     static int64_t maxFrameBufferAcquiredBuffers;
 152
 153     // Indicate if platform supports color management on its
 154     // wide-color display. This is typically found on devices
 155     // with wide gamut (e.g. Display-P3) display.
 156     // This also allows devices with wide-color displays that don't
 157     // want to support color management to disable color management.
 158     static bool hasWideColorDisplay;
 159
 160     static char const* getServiceName() ANDROID_API {
 161         return "SurfaceFlinger";
 162     }
 163
 164     SurfaceFlinger() ANDROID_API;
 165
 166     // must be called before clients can connect
 167     void init() ANDROID_API;
 168
 169     // starts SurfaceFlinger main loop in the current thread
 170     void run() ANDROID_API;
 171
 172     enum {
 173         EVENT_VSYNC = HWC_EVENT_VSYNC
 174     };
 175
 176     // post an asynchronous message to the main thread
 177     status_t postMessageAsync(const sp<MessageBase>& msg, nsecs_t reltime = 0, uint32_t flags = 0);
 178
 179     // post a synchronous message to the main thread
 180     status_t postMessageSync(const sp<MessageBase>& msg, nsecs_t reltime = 0, uint32_t flags = 0);
 181
 182     // force full composition on all displays
 183     void repaintEverything();
 184
 185     // returns the default Display
 186     sp<const DisplayDevice> getDefaultDisplayDevice() const {
 187         Mutex::Autolock _l(mStateLock);
 188         return getDefaultDisplayDeviceLocked();
 189     }
 190
 191     // utility function to delete a texture on the main thread
 192     void deleteTextureAsync(uint32_t texture);
 193
 194     // enable/disable h/w composer event
 195     // TODO: this should be made accessible only to EventThread
 196 #ifdef USE_HWC2
 197     void setVsyncEnabled(int disp, int enabled);
 198 #else
 199     void eventControl(int disp, int event, int enabled);
 200 #endif
 201
 202     // called on the main thread by MessageQueue when an internal message
 203     // is received
 204     // TODO: this should be made accessible only to MessageQueue
 205     void onMessageReceived(int32_t what);
 206
 207     // for debugging only
 208     // TODO: this should be made accessible only to HWComposer
 209     const Vector< sp<Layer> >& getLayerSortedByZForHwcDisplay(int id);
 210
 211     RenderEngine& getRenderEngine() const {
 212         return *mRenderEngine;
 213     }
 214
 215     bool authenticateSurfaceTextureLocked(
 216         const sp<IGraphicBufferProducer>& bufferProducer) const;
 217
 218 private:
 219     friend class Client;
 220     friend class DisplayEventConnection;
 221     friend class EventThread;
 222     friend class Layer;
 223     friend class MonitoredProducer;
 224
 225     // This value is specified in number of frames.  Log frame stats at most
 226     // every half hour.
 227     enum { LOG_FRAME_STATS_PERIOD =  30*60*60 };
 228
 229     static const size_t MAX_LAYERS = 4096;
 230     static constexpr const char* kTimestampProperty = "service.sf.present_timestamp";
 231
 232     // We're reference counted, never destroy SurfaceFlinger directly
 233     virtual ~SurfaceFlinger();
 234
 235     /* ------------------------------------------------------------------------
 236      * Internal data structures
 237      */
 238
 239     class State {
 240     public:
 241         explicit State(LayerVector::StateSet set) : stateSet(set) {}
 242         State& operator=(const State& other) {
 243             // We explicitly don't copy stateSet so that, e.g., mDrawingState
 244             // always uses the Drawing StateSet.
 245             layersSortedByZ = other.layersSortedByZ;
 246             displays = other.displays;
 247             return *this;
 248         }
 249
 250         const LayerVector::StateSet stateSet = LayerVector::StateSet::Invalid;
 251         LayerVector layersSortedByZ;
 252         DefaultKeyedVector< wp<IBinder>, DisplayDeviceState> displays;
 253
 254         void traverseInZOrder(const LayerVector::Visitor& visitor) const;
 255         void traverseInReverseZOrder(const LayerVector::Visitor& visitor) const;
 256     };
 257
 258     /* ------------------------------------------------------------------------
 259      * IBinder interface
 260      */
 261     virtual status_t onTransact(uint32_t code, const Parcel& data,
 262         Parcel* reply, uint32_t flags);
 263     virtual status_t dump(int fd, const Vector<String16>& args);
 264
 265     /* ------------------------------------------------------------------------
 266      * ISurfaceComposer interface
 267      */
 268     virtual sp<ISurfaceComposerClient> createConnection();
 269     virtual sp<ISurfaceComposerClient> createScopedConnection(const sp<IGraphicBufferProducer>& gbp);
 270     virtual sp<IBinder> createDisplay(const String8& displayName, bool secure);
 271     virtual void destroyDisplay(const sp<IBinder>& display);
 272     virtual sp<IBinder> getBuiltInDisplay(int32_t id);
 273     virtual void setTransactionState(const Vector<ComposerState>& state,
 274             const Vector<DisplayState>& displays, uint32_t flags);
 275     virtual void bootFinished();
 276     virtual bool authenticateSurfaceTexture(
 277         const sp<IGraphicBufferProducer>& bufferProducer) const;
 278     virtual status_t getSupportedFrameTimestamps(
 279             std::vector<FrameEvent>* outSupported) const;
 280     virtual sp<IDisplayEventConnection> createDisplayEventConnection(
 281             ISurfaceComposer::VsyncSource vsyncSource = eVsyncSourceApp);
 282     virtual status_t captureScreen(const sp<IBinder>& display,
 283             const sp<IGraphicBufferProducer>& producer,
 284             Rect sourceCrop, uint32_t reqWidth, uint32_t reqHeight,
 285             int32_t minLayerZ, int32_t maxLayerZ,
 286             bool useIdentityTransform, ISurfaceComposer::Rotation rotation);
 287     virtual status_t getDisplayStats(const sp<IBinder>& display,
 288             DisplayStatInfo* stats);
 289     virtual status_t getDisplayConfigs(const sp<IBinder>& display,
 290             Vector<DisplayInfo>* configs);
 291     virtual int getActiveConfig(const sp<IBinder>& display);
 292     virtual status_t getDisplayColorModes(const sp<IBinder>& display,
 293             Vector<android_color_mode_t>* configs);
 294     virtual android_color_mode_t getActiveColorMode(const sp<IBinder>& display);
 295     virtual status_t setActiveColorMode(const sp<IBinder>& display, android_color_mode_t colorMode);
 296     virtual void setPowerMode(const sp<IBinder>& display, int mode);
 297     virtual status_t setActiveConfig(const sp<IBinder>& display, int id);
 298     virtual status_t clearAnimationFrameStats();
 299     virtual status_t getAnimationFrameStats(FrameStats* outStats) const;
 300     virtual status_t getHdrCapabilities(const sp<IBinder>& display,
 301             HdrCapabilities* outCapabilities) const;
 302     virtual status_t enableVSyncInjections(bool enable);
 303     virtual status_t injectVSync(nsecs_t when);
 304
 305
 306     /* ------------------------------------------------------------------------
 307      * DeathRecipient interface
 308      */
 309     virtual void binderDied(const wp<IBinder>& who);
 310
 311     /* ------------------------------------------------------------------------
 312      * RefBase interface
 313      */
 314     virtual void onFirstRef();
 315
 316     /* ------------------------------------------------------------------------
 317      * HWComposer::EventHandler interface
 318      */
 319     virtual void onVSyncReceived(HWComposer* composer, int type, nsecs_t timestamp);
 320     virtual void onHotplugReceived(HWComposer* composer, int disp, bool connected);
 321     virtual void onInvalidateReceived(HWComposer* composer);
 322
 323     /* ------------------------------------------------------------------------
 324      * Message handling
 325      */
 326     void waitForEvent();
 327     void signalTransaction();
 328     void signalLayerUpdate();
 329     void signalRefresh();
 330
 331     // called on the main thread in response to initializeDisplays()
 332     void onInitializeDisplays();
 333     // called on the main thread in response to setActiveConfig()
 334     void setActiveConfigInternal(const sp<DisplayDevice>& hw, int mode);
 335     // called on the main thread in response to setPowerMode()
 336     void setPowerModeInternal(const sp<DisplayDevice>& hw, int mode);
 337
 338     // Called on the main thread in response to setActiveColorMode()
 339     void setActiveColorModeInternal(const sp<DisplayDevice>& hw, android_color_mode_t colorMode);
 340
 341     // Returns whether the transaction actually modified any state
 342     bool handleMessageTransaction();
 343
 344     // Returns whether a new buffer has been latched (see handlePageFlip())
 345     bool handleMessageInvalidate();
 346
 347     void handleMessageRefresh();
 348
 349     void handleTransaction(uint32_t transactionFlags);
 350     void handleTransactionLocked(uint32_t transactionFlags);
 351
 352     void updateCursorAsync();
 353
 354     /* handlePageFlip - latch a new buffer if available and compute the dirty
 355      * region. Returns whether a new buffer has been latched, i.e., whether it
 356      * is necessary to perform a refresh during this vsync.
 357      */
 358     bool handlePageFlip();
 359
 360     /* ------------------------------------------------------------------------
 361      * Transactions
 362      */
 363     uint32_t getTransactionFlags(uint32_t flags);
 364     uint32_t peekTransactionFlags();
 365     uint32_t setTransactionFlags(uint32_t flags);
 366     void commitTransaction();
 367     uint32_t setClientStateLocked(const sp<Client>& client, const layer_state_t& s);
 368     uint32_t setDisplayStateLocked(const DisplayState& s);
 369
 370     /* ------------------------------------------------------------------------
 371      * Layer management
 372      */
 373     status_t createLayer(const String8& name, const sp<Client>& client,
 374             uint32_t w, uint32_t h, PixelFormat format, uint32_t flags,
 375             uint32_t windowType, uint32_t ownerUid, sp<IBinder>* handle,
 376             sp<IGraphicBufferProducer>* gbp, sp<Layer>* parent);
 377
 378     status_t createNormalLayer(const sp<Client>& client, const String8& name,
 379             uint32_t w, uint32_t h, uint32_t flags, PixelFormat& format,
 380             sp<IBinder>* outHandle, sp<IGraphicBufferProducer>* outGbp,
 381             sp<Layer>* outLayer);
 382
 383     status_t createDimLayer(const sp<Client>& client, const String8& name,
 384             uint32_t w, uint32_t h, uint32_t flags, sp<IBinder>* outHandle,
 385             sp<IGraphicBufferProducer>* outGbp, sp<Layer>* outLayer);
 386
 387     String8 getUniqueLayerName(const String8& name);
 388
 389     // called in response to the window-manager calling
 390     // ISurfaceComposerClient::destroySurface()
 391     status_t onLayerRemoved(const sp<Client>& client, const sp<IBinder>& handle);
 392
 393     // called when all clients have released all their references to
 394     // this layer meaning it is entirely safe to destroy all
 395     // resources associated to this layer.
 396     status_t onLayerDestroyed(const wp<Layer>& layer);
 397
 398     // remove a layer from SurfaceFlinger immediately
 399     status_t removeLayer(const sp<Layer>& layer, bool topLevelOnly = false);
 400
 401     // add a layer to SurfaceFlinger
 402     status_t addClientLayer(const sp<Client>& client,
 403             const sp<IBinder>& handle,
 404             const sp<IGraphicBufferProducer>& gbc,
 405             const sp<Layer>& lbc,
 406             const sp<Layer>& parent);
 407
 408     /* ------------------------------------------------------------------------
 409      * Boot animation, on/off animations and screen capture
 410      */
 411
 412     void startBootAnim();
 413
 414     void renderScreenImplLocked(
 415             const sp<const DisplayDevice>& hw,
 416             Rect sourceCrop, uint32_t reqWidth, uint32_t reqHeight,
 417             int32_t minLayerZ, int32_t maxLayerZ,
 418             bool yswap, bool useIdentityTransform, Transform::orientation_flags rotation);
 419
 420 #ifdef USE_HWC2
 421     status_t captureScreenImplLocked(const sp<const DisplayDevice>& device,
 422                                      ANativeWindowBuffer* buffer, Rect sourceCrop,
 423                                      uint32_t reqWidth, uint32_t reqHeight, int32_t minLayerZ,
 424                                      int32_t maxLayerZ, bool useIdentityTransform,
 425                                      Transform::orientation_flags rotation, bool isLocalScreenshot,
 426                                      int* outSyncFd);
 427 #else
 428     status_t captureScreenImplLocked(
 429             const sp<const DisplayDevice>& hw,
 430             const sp<IGraphicBufferProducer>& producer,
 431             Rect sourceCrop, uint32_t reqWidth, uint32_t reqHeight,
 432             int32_t minLayerZ, int32_t maxLayerZ,
 433             bool useIdentityTransform, Transform::orientation_flags rotation,
 434             bool isLocalScreenshot);
 435 #endif
 436
 437     sp<StartBootAnimThread> mStartBootAnimThread = nullptr;
 438
 439     /* ------------------------------------------------------------------------
 440      * EGL
 441      */
 442     size_t getMaxTextureSize() const;
 443     size_t getMaxViewportDims() const;
 444
 445     /* ------------------------------------------------------------------------
 446      * Display and layer stack management
 447      */
 448     // called when starting, or restarting after system_server death
 449     void initializeDisplays();
 450
 451     // Create an IBinder for a builtin display and add it to current state
 452     void createBuiltinDisplayLocked(DisplayDevice::DisplayType type);
 453
 454
 455     sp<const DisplayDevice> getDisplayDevice(const wp<IBinder>& dpy) const {
 456       Mutex::Autolock _l(mStateLock);
 457       return getDisplayDeviceLocked(dpy);
 458     }
 459
 460     sp<DisplayDevice> getDisplayDevice(const wp<IBinder>& dpy) {
 461       Mutex::Autolock _l(mStateLock);
 462       return getDisplayDeviceLocked(dpy);
 463     }
 464
 465     // NOTE: can only be called from the main thread or with mStateLock held
 466     sp<const DisplayDevice> getDisplayDeviceLocked(const wp<IBinder>& dpy) const {
 467         return mDisplays.valueFor(dpy);
 468     }
 469
 470     // NOTE: can only be called from the main thread or with mStateLock held
 471     sp<DisplayDevice> getDisplayDeviceLocked(const wp<IBinder>& dpy) {
 472         return mDisplays.valueFor(dpy);
 473     }
 474
 475     sp<const DisplayDevice> getDefaultDisplayDeviceLocked() const {
 476         return getDisplayDeviceLocked(mBuiltinDisplays[DisplayDevice::DISPLAY_PRIMARY]);
 477     }
 478
 479     void createDefaultDisplayDevice();
 480
 481     int32_t getDisplayType(const sp<IBinder>& display) {
 482         if (!display.get()) return NAME_NOT_FOUND;
 483         for (int i = 0; i < DisplayDevice::NUM_BUILTIN_DISPLAY_TYPES; ++i) {
 484             if (display == mBuiltinDisplays[i]) {
 485                 return i;
 486             }
 487         }
 488         return NAME_NOT_FOUND;
 489     }
 490
 491     // mark a region of a layer stack dirty. this updates the dirty
 492     // region of all screens presenting this layer stack.
 493     void invalidateLayerStack(uint32_t layerStack, const Region& dirty);
 494
 495 #ifndef USE_HWC2
 496     int32_t allocateHwcDisplayId(DisplayDevice::DisplayType type);
 497 #endif
 498
 499     /* ------------------------------------------------------------------------
 500      * H/W composer
 501      */
 502
 503     HWComposer& getHwComposer() const { return *mHwc; }
 504
 505     /* ------------------------------------------------------------------------
 506      * Compositing
 507      */
 508     void invalidateHwcGeometry();
 509     void computeVisibleRegions(uint32_t layerStack,
 510             Region& dirtyRegion, Region& opaqueRegion);
 511
 512     void preComposition(nsecs_t refreshStartTime);
 513     void postComposition(nsecs_t refreshStartTime);
 514     void updateCompositorTiming(
 515             nsecs_t vsyncPhase, nsecs_t vsyncInterval, nsecs_t compositeTime,
 516             std::shared_ptr<FenceTime>& presentFenceTime);
 517     void setCompositorTimingSnapped(
 518             nsecs_t vsyncPhase, nsecs_t vsyncInterval,
 519             nsecs_t compositeToPresentLatency);
 520     void rebuildLayerStacks();
 521
 522     // Given a dataSpace, returns the appropriate color_mode to use
 523     // to display that dataSpace.
 524     android_color_mode pickColorMode(android_dataspace dataSpace) const;
 525     android_dataspace bestTargetDataSpace(android_dataspace a, android_dataspace b) const;
 526
 527     mat4 computeSaturationMatrix() const;
 528
 529     void setUpHWComposer();
 530     void doComposition();
 531     void doDebugFlashRegions();
 532     void doDisplayComposition(const sp<const DisplayDevice>& displayDevice, const Region& dirtyRegion);
 533
 534     // compose surfaces for display hw. this fails if using GL and the surface
 535     // has been destroyed and is no longer valid.
 536     bool doComposeSurfaces(const sp<const DisplayDevice>& displayDevice, const Region& dirty);
 537
 538     void postFramebuffer();
 539     void drawWormhole(const sp<const DisplayDevice>& displayDevice, const Region& region) const;
 540
 541     /* ------------------------------------------------------------------------
 542      * Display management
 543      */
 544
 545     /* ------------------------------------------------------------------------
 546      * VSync
 547      */
 548     void enableHardwareVsync();
 549     void resyncToHardwareVsync(bool makeAvailable);
 550     void disableHardwareVsync(bool makeUnavailable);
 551
 552 public:
 553     void resyncWithRateLimit();
 554     void getCompositorTiming(CompositorTiming* compositorTiming);
 555 private:
 556
 557     /* ------------------------------------------------------------------------
 558      * Debugging & dumpsys
 559      */
 560     void listLayersLocked(const Vector<String16>& args, size_t& index, String8& result) const;
 561     void dumpStatsLocked(const Vector<String16>& args, size_t& index, String8& result) const;
 562     void clearStatsLocked(const Vector<String16>& args, size_t& index, String8& result);
 563     void dumpAllLocked(const Vector<String16>& args, size_t& index, String8& result) const;
 564     bool startDdmConnection();
 565     void appendSfConfigString(String8& result) const;
 566     void checkScreenshot(size_t w, size_t s, size_t h, void const* vaddr,
 567             const sp<const DisplayDevice>& hw,
 568             int32_t minLayerZ, int32_t maxLayerZ);
 569
 570     void logFrameStats();
 571
 572     void dumpStaticScreenStats(String8& result) const;
 573     // Not const because each Layer needs to query Fences and cache timestamps.
 574     void dumpFrameEventsLocked(String8& result);
 575
 576     void recordBufferingStats(const char* layerName,
 577             std::vector<OccupancyTracker::Segment>&& history);
 578     void dumpBufferingStats(String8& result) const;
 579     void dumpWideColorInfo(String8& result) const;
 580
 581     bool isLayerTripleBufferingDisabled() const {
 582         return this->mLayerTripleBufferingDisabled;
 583     }
 584
 585 #ifdef USE_HWC2
 586     /* ------------------------------------------------------------------------
 587      * VrFlinger
 588      */
 589     void clearHwcLayers(const LayerVector& layers);
 590     void resetHwcLocked();
 591
 592     // Check to see if we should handoff to vr flinger.
 593     void updateVrFlinger();
 594 #endif
 595
 596     /* ------------------------------------------------------------------------
 597      * Attributes
 598      */
 599
 600     // access must be protected by mStateLock
 601     mutable Mutex mStateLock;
 602     State mCurrentState{LayerVector::StateSet::Current};
 603     volatile int32_t mTransactionFlags;
 604     Condition mTransactionCV;
 605     bool mTransactionPending;
 606     bool mAnimTransactionPending;
 607     SortedVector< sp<Layer> > mLayersPendingRemoval;
 608     SortedVector< wp<IBinder> > mGraphicBufferProducerList;
 609
 610     // protected by mStateLock (but we could use another lock)
 611     bool mLayersRemoved;
 612     bool mLayersAdded;
 613
 614     // access must be protected by mInvalidateLock
 615     volatile int32_t mRepaintEverything;
 616
 617     // current, real and vr hardware composers.
 618     HWComposer* mHwc;
 619 #ifdef USE_HWC2
 620     HWComposer* mRealHwc;
 621     HWComposer* mVrHwc;
 622 #endif
 623     // constant members (no synchronization needed for access)
 624     RenderEngine* mRenderEngine;
 625     nsecs_t mBootTime;
 626     bool mGpuToCpuSupported;
 627     sp<EventThread> mEventThread;
 628     sp<EventThread> mSFEventThread;
 629     sp<EventThread> mInjectorEventThread;
 630     sp<InjectVSyncSource> mVSyncInjector;
 631     sp<EventControlThread> mEventControlThread;
 632     EGLContext mEGLContext;
 633     EGLDisplay mEGLDisplay;
 634     sp<IBinder> mBuiltinDisplays[DisplayDevice::NUM_BUILTIN_DISPLAY_TYPES];
 635
 636 #ifdef USE_HWC2
 637     std::unique_ptr<dvr::VrFlinger> mVrFlinger;
 638 #endif
 639
 640     // Can only accessed from the main thread, these members
 641     // don't need synchronization
 642     State mDrawingState{LayerVector::StateSet::Drawing};
 643     bool mVisibleRegionsDirty;
 644 #ifndef USE_HWC2
 645     bool mHwWorkListDirty;
 646 #else
 647     bool mGeometryInvalid;
 648 #endif
 649     bool mAnimCompositionPending;
 650 #ifdef USE_HWC2
 651     std::vector<sp<Layer>> mLayersWithQueuedFrames;
 652     sp<Fence> mPreviousPresentFence = Fence::NO_FENCE;
 653     bool mHadClientComposition = false;
 654 #endif
 655     FenceTimeline mGlCompositionDoneTimeline;
 656     FenceTimeline mDisplayTimeline;
 657
 658     // this may only be written from the main thread with mStateLock held
 659     // it may be read from other threads with mStateLock held
 660     DefaultKeyedVector< wp<IBinder>, sp<DisplayDevice> > mDisplays;
 661
 662     // don't use a lock for these, we don't care
 663     int mDebugRegion;
 664     int mDebugDDMS;
 665     int mDebugDisableHWC;
 666     int mDebugDisableTransformHint;
 667     volatile nsecs_t mDebugInSwapBuffers;
 668     nsecs_t mLastSwapBufferTime;
 669     volatile nsecs_t mDebugInTransaction;
 670     nsecs_t mLastTransactionTime;
 671     bool mBootFinished;
 672     bool mForceFullDamage;
 673 #ifdef USE_HWC2
 674     bool mPropagateBackpressure = true;
 675 #endif
 676     SurfaceInterceptor mInterceptor;
 677     bool mUseHwcVirtualDisplays = false;
 678
 679     // Restrict layers to use two buffers in their bufferqueues.
 680     bool mLayerTripleBufferingDisabled = false;
 681
 682     // these are thread safe
 683     mutable MessageQueue mEventQueue;
 684     FrameTracker mAnimFrameTracker;
 685     DispSync mPrimaryDispSync;
 686
 687     // protected by mDestroyedLayerLock;
 688     mutable Mutex mDestroyedLayerLock;
 689     Vector<Layer const *> mDestroyedLayers;
 690
 691     // protected by mHWVsyncLock
 692     Mutex mHWVsyncLock;
 693     bool mPrimaryHWVsyncEnabled;
 694     bool mHWVsyncAvailable;
 695
 696     // protected by mCompositorTimingLock;
 697     mutable std::mutex mCompositorTimingLock;
 698     CompositorTiming mCompositorTiming;
 699
 700     // Only accessed from the main thread.
 701     struct CompositePresentTime {
 702         nsecs_t composite { -1 };
 703         std::shared_ptr<FenceTime> display { FenceTime::NO_FENCE };
 704     };
 705     std::queue<CompositePresentTime> mCompositePresentTimes;
 706
 707     std::atomic<bool> mRefreshPending{false};
 708
 709     /* ------------------------------------------------------------------------
 710      * Feature prototyping
 711      */
 712
 713     bool mInjectVSyncs;
 714
 715     Daltonizer mDaltonizer;
 716 #ifndef USE_HWC2
 717     bool mDaltonize;
 718 #endif
 719
 720     mat4 mPreviousColorMatrix;
 721     mat4 mColorMatrix;
 722     bool mHasColorMatrix;
 723
 724     // Static screen stats
 725     bool mHasPoweredOff;
 726     static const size_t NUM_BUCKETS = 8; // < 1-7, 7+
 727     nsecs_t mFrameBuckets[NUM_BUCKETS];
 728     nsecs_t mTotalTime;
 729     std::atomic<nsecs_t> mLastSwapTime;
 730
 731     size_t mNumLayers;
 732
 733     // Double- vs. triple-buffering stats
 734     struct BufferingStats {
 735         BufferingStats()
 736           : numSegments(0),
 737             totalTime(0),
 738             twoBufferTime(0),
 739             doubleBufferedTime(0),
 740             tripleBufferedTime(0) {}
 741
 742         size_t numSegments;
 743         nsecs_t totalTime;
 744
 745         // "Two buffer" means that a third buffer was never used, whereas
 746         // "double-buffered" means that on average the segment only used two
 747         // buffers (though it may have used a third for some part of the
 748         // segment)
 749         nsecs_t twoBufferTime;
 750         nsecs_t doubleBufferedTime;
 751         nsecs_t tripleBufferedTime;
 752     };
 753     mutable Mutex mBufferingStatsMutex;
 754     std::unordered_map<std::string, BufferingStats> mBufferingStats;
 755
 756     // Verify that transaction is being called by an approved process:
 757     // either AID_GRAPHICS or AID_SYSTEM.
 758     status_t CheckTransactCodeCredentials(uint32_t code);
 759
 760 #ifdef USE_HWC2
 761     std::atomic<bool> mVrFlingerRequestsDisplay;
 762     static bool useVrFlinger;
 763 #endif
 764
 765     float mSaturation = 1.0f;
 766 };
 767 }; // namespace android
 768
 769 #endif // ANDROID_SURFACE_FLINGER_H