SurfaceFlinger.h revision d85084b2b65828442eafaff9b811e9b6c9ca9fad
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 <stdint.h> 21#include <sys/types.h> 22 23#include <EGL/egl.h> 24 25/* 26 * NOTE: Make sure this file doesn't include anything from <gl/ > or <gl2/ > 27 */ 28 29#include <cutils/compiler.h> 30 31#include <utils/Atomic.h> 32#include <utils/Errors.h> 33#include <utils/KeyedVector.h> 34#include <utils/RefBase.h> 35#include <utils/SortedVector.h> 36#include <utils/threads.h> 37 38#include <binder/IMemory.h> 39 40#include <ui/PixelFormat.h> 41#include <ui/mat4.h> 42 43#include <gui/ISurfaceComposer.h> 44#include <gui/ISurfaceComposerClient.h> 45 46#include <hardware/hwcomposer_defs.h> 47 48#include <private/gui/LayerState.h> 49 50#include "Barrier.h" 51#include "DisplayDevice.h" 52#include "DispSync.h" 53#include "FrameTracker.h" 54#include "MessageQueue.h" 55 56#include "DisplayHardware/HWComposer.h" 57#include "Effects/Daltonizer.h" 58 59namespace android { 60 61// --------------------------------------------------------------------------- 62 63class Client; 64class DisplayEventConnection; 65class EventThread; 66class IGraphicBufferAlloc; 67class Layer; 68class LayerDim; 69class Surface; 70class RenderEngine; 71class EventControlThread; 72 73// --------------------------------------------------------------------------- 74 75enum { 76 eTransactionNeeded = 0x01, 77 eTraversalNeeded = 0x02, 78 eDisplayTransactionNeeded = 0x04, 79 eTransactionMask = 0x07 80}; 81 82class SurfaceFlinger : public BnSurfaceComposer, 83 private IBinder::DeathRecipient, 84 private HWComposer::EventHandler 85{ 86public: 87 static char const* getServiceName() ANDROID_API { 88 return "SurfaceFlinger"; 89 } 90 91 SurfaceFlinger() ANDROID_API; 92 93 // must be called before clients can connect 94 void init() ANDROID_API; 95 96 // starts SurfaceFlinger main loop in the current thread 97 void run() ANDROID_API; 98 99 enum { 100 EVENT_VSYNC = HWC_EVENT_VSYNC 101 }; 102 103 // post an asynchronous message to the main thread 104 status_t postMessageAsync(const sp<MessageBase>& msg, nsecs_t reltime = 0, uint32_t flags = 0); 105 106 // post a synchronous message to the main thread 107 status_t postMessageSync(const sp<MessageBase>& msg, nsecs_t reltime = 0, uint32_t flags = 0); 108 109 // force full composition on all displays 110 void repaintEverything(); 111 112 // returns the default Display 113 sp<const DisplayDevice> getDefaultDisplayDevice() const { 114 return getDisplayDevice(mBuiltinDisplays[DisplayDevice::DISPLAY_PRIMARY]); 115 } 116 117 // utility function to delete a texture on the main thread 118 void deleteTextureAsync(uint32_t texture); 119 120 // enable/disable h/w composer event 121 // TODO: this should be made accessible only to EventThread 122 void eventControl(int disp, int event, int enabled); 123 124 // called on the main thread by MessageQueue when an internal message 125 // is received 126 // TODO: this should be made accessible only to MessageQueue 127 void onMessageReceived(int32_t what); 128 129 // for debugging only 130 // TODO: this should be made accessible only to HWComposer 131 const Vector< sp<Layer> >& getLayerSortedByZForHwcDisplay(int id); 132 133 RenderEngine& getRenderEngine() const { 134 return *mRenderEngine; 135 } 136 137private: 138 friend class Client; 139 friend class DisplayEventConnection; 140 friend class Layer; 141 friend class MonitoredProducer; 142 143 // This value is specified in number of frames. Log frame stats at most 144 // every half hour. 145 enum { LOG_FRAME_STATS_PERIOD = 30*60*60 }; 146 147 // We're reference counted, never destroy SurfaceFlinger directly 148 virtual ~SurfaceFlinger(); 149 150 /* ------------------------------------------------------------------------ 151 * Internal data structures 152 */ 153 154 class LayerVector : public SortedVector< sp<Layer> > { 155 public: 156 LayerVector(); 157 LayerVector(const LayerVector& rhs); 158 virtual int do_compare(const void* lhs, const void* rhs) const; 159 }; 160 161 struct DisplayDeviceState { 162 DisplayDeviceState(); 163 DisplayDeviceState(DisplayDevice::DisplayType type); 164 bool isValid() const { return type >= 0; } 165 bool isMainDisplay() const { return type == DisplayDevice::DISPLAY_PRIMARY; } 166 bool isVirtualDisplay() const { return type >= DisplayDevice::DISPLAY_VIRTUAL; } 167 DisplayDevice::DisplayType type; 168 sp<IGraphicBufferProducer> surface; 169 uint32_t layerStack; 170 Rect viewport; 171 Rect frame; 172 uint8_t orientation; 173 String8 displayName; 174 bool isSecure; 175 }; 176 177 struct State { 178 LayerVector layersSortedByZ; 179 DefaultKeyedVector< wp<IBinder>, DisplayDeviceState> displays; 180 }; 181 182 /* ------------------------------------------------------------------------ 183 * IBinder interface 184 */ 185 virtual status_t onTransact(uint32_t code, const Parcel& data, 186 Parcel* reply, uint32_t flags); 187 virtual status_t dump(int fd, const Vector<String16>& args); 188 189 /* ------------------------------------------------------------------------ 190 * ISurfaceComposer interface 191 */ 192 virtual sp<ISurfaceComposerClient> createConnection(); 193 virtual sp<IGraphicBufferAlloc> createGraphicBufferAlloc(); 194 virtual sp<IBinder> createDisplay(const String8& displayName, bool secure); 195 virtual void destroyDisplay(const sp<IBinder>& display); 196 virtual sp<IBinder> getBuiltInDisplay(int32_t id); 197 virtual void setTransactionState(const Vector<ComposerState>& state, 198 const Vector<DisplayState>& displays, uint32_t flags); 199 virtual void bootFinished(); 200 virtual bool authenticateSurfaceTexture( 201 const sp<IGraphicBufferProducer>& bufferProducer) const; 202 virtual sp<IDisplayEventConnection> createDisplayEventConnection(); 203 virtual status_t captureScreen(const sp<IBinder>& display, 204 const sp<IGraphicBufferProducer>& producer, 205 uint32_t reqWidth, uint32_t reqHeight, 206 uint32_t minLayerZ, uint32_t maxLayerZ, 207 bool useIdentityTransform); 208 // called when screen needs to turn off 209 virtual void blank(const sp<IBinder>& display); 210 // called when screen is turning back on 211 virtual void unblank(const sp<IBinder>& display); 212 virtual status_t getDisplayInfo(const sp<IBinder>& display, DisplayInfo* info); 213 virtual status_t clearAnimationFrameStats(); 214 virtual status_t getAnimationFrameStats(FrameStats* outStats) const; 215 216 /* ------------------------------------------------------------------------ 217 * DeathRecipient interface 218 */ 219 virtual void binderDied(const wp<IBinder>& who); 220 221 /* ------------------------------------------------------------------------ 222 * RefBase interface 223 */ 224 virtual void onFirstRef(); 225 226 /* ------------------------------------------------------------------------ 227 * HWComposer::EventHandler interface 228 */ 229 virtual void onVSyncReceived(int type, nsecs_t timestamp); 230 virtual void onHotplugReceived(int disp, bool connected); 231 232 /* ------------------------------------------------------------------------ 233 * Message handling 234 */ 235 void waitForEvent(); 236 void signalTransaction(); 237 void signalLayerUpdate(); 238 void signalRefresh(); 239 240 // called on the main thread in response to initializeDisplays() 241 void onInitializeDisplays(); 242 // called on the main thread in response to blank() 243 void onScreenReleased(const sp<const DisplayDevice>& hw); 244 // called on the main thread in response to unblank() 245 void onScreenAcquired(const sp<const DisplayDevice>& hw); 246 247 void handleMessageTransaction(); 248 void handleMessageInvalidate(); 249 void handleMessageRefresh(); 250 251 void handleTransaction(uint32_t transactionFlags); 252 void handleTransactionLocked(uint32_t transactionFlags); 253 254 /* handlePageFilp: this is were we latch a new buffer 255 * if available and compute the dirty region. 256 */ 257 void handlePageFlip(); 258 259 /* ------------------------------------------------------------------------ 260 * Transactions 261 */ 262 uint32_t getTransactionFlags(uint32_t flags); 263 uint32_t peekTransactionFlags(uint32_t flags); 264 uint32_t setTransactionFlags(uint32_t flags); 265 void commitTransaction(); 266 uint32_t setClientStateLocked(const sp<Client>& client, const layer_state_t& s); 267 uint32_t setDisplayStateLocked(const DisplayState& s); 268 269 /* ------------------------------------------------------------------------ 270 * Layer management 271 */ 272 status_t createLayer(const String8& name, const sp<Client>& client, 273 uint32_t w, uint32_t h, PixelFormat format, uint32_t flags, 274 sp<IBinder>* handle, sp<IGraphicBufferProducer>* gbp); 275 276 status_t createNormalLayer(const sp<Client>& client, const String8& name, 277 uint32_t w, uint32_t h, uint32_t flags, PixelFormat& format, 278 sp<IBinder>* outHandle, sp<IGraphicBufferProducer>* outGbp, 279 sp<Layer>* outLayer); 280 281 status_t createDimLayer(const sp<Client>& client, const String8& name, 282 uint32_t w, uint32_t h, uint32_t flags, sp<IBinder>* outHandle, 283 sp<IGraphicBufferProducer>* outGbp, sp<Layer>* outLayer); 284 285 // called in response to the window-manager calling 286 // ISurfaceComposerClient::destroySurface() 287 status_t onLayerRemoved(const sp<Client>& client, const sp<IBinder>& handle); 288 289 // called when all clients have released all their references to 290 // this layer meaning it is entirely safe to destroy all 291 // resources associated to this layer. 292 status_t onLayerDestroyed(const wp<Layer>& layer); 293 294 // remove a layer from SurfaceFlinger immediately 295 status_t removeLayer(const sp<Layer>& layer); 296 297 // add a layer to SurfaceFlinger 298 void addClientLayer(const sp<Client>& client, 299 const sp<IBinder>& handle, 300 const sp<IGraphicBufferProducer>& gbc, 301 const sp<Layer>& lbc); 302 303 /* ------------------------------------------------------------------------ 304 * Boot animation, on/off animations and screen capture 305 */ 306 307 void startBootAnim(); 308 309 void renderScreenImplLocked( 310 const sp<const DisplayDevice>& hw, 311 uint32_t reqWidth, uint32_t reqHeight, 312 uint32_t minLayerZ, uint32_t maxLayerZ, 313 bool yswap, bool useIdentityTransform); 314 315 status_t captureScreenImplLocked( 316 const sp<const DisplayDevice>& hw, 317 const sp<IGraphicBufferProducer>& producer, 318 uint32_t reqWidth, uint32_t reqHeight, 319 uint32_t minLayerZ, uint32_t maxLayerZ, 320 bool useIdentityTransform); 321 322 /* ------------------------------------------------------------------------ 323 * EGL 324 */ 325 size_t getMaxTextureSize() const; 326 size_t getMaxViewportDims() const; 327 328 /* ------------------------------------------------------------------------ 329 * Display and layer stack management 330 */ 331 // called when starting, or restarting after system_server death 332 void initializeDisplays(); 333 334 // Create an IBinder for a builtin display and add it to current state 335 void createBuiltinDisplayLocked(DisplayDevice::DisplayType type); 336 337 // NOTE: can only be called from the main thread or with mStateLock held 338 sp<const DisplayDevice> getDisplayDevice(const wp<IBinder>& dpy) const { 339 return mDisplays.valueFor(dpy); 340 } 341 342 // NOTE: can only be called from the main thread or with mStateLock held 343 sp<DisplayDevice> getDisplayDevice(const wp<IBinder>& dpy) { 344 return mDisplays.valueFor(dpy); 345 } 346 347 // mark a region of a layer stack dirty. this updates the dirty 348 // region of all screens presenting this layer stack. 349 void invalidateLayerStack(uint32_t layerStack, const Region& dirty); 350 351 // allocate a h/w composer display id 352 int32_t allocateHwcDisplayId(DisplayDevice::DisplayType type); 353 354 /* ------------------------------------------------------------------------ 355 * H/W composer 356 */ 357 358 HWComposer& getHwComposer() const { return *mHwc; } 359 360 /* ------------------------------------------------------------------------ 361 * Compositing 362 */ 363 void invalidateHwcGeometry(); 364 static void computeVisibleRegions( 365 const LayerVector& currentLayers, uint32_t layerStack, 366 Region& dirtyRegion, Region& opaqueRegion); 367 368 void preComposition(); 369 void postComposition(); 370 void rebuildLayerStacks(); 371 void setUpHWComposer(); 372 void doComposition(); 373 void doDebugFlashRegions(); 374 void doDisplayComposition(const sp<const DisplayDevice>& hw, const Region& dirtyRegion); 375 void doComposeSurfaces(const sp<const DisplayDevice>& hw, const Region& dirty); 376 377 void postFramebuffer(); 378 void drawWormhole(const sp<const DisplayDevice>& hw, const Region& region) const; 379 380 /* ------------------------------------------------------------------------ 381 * Display management 382 */ 383 384 /* ------------------------------------------------------------------------ 385 * VSync 386 */ 387 void enableHardwareVsync(); 388 void disableHardwareVsync(bool makeUnavailable); 389 void resyncToHardwareVsync(bool makeAvailable); 390 391 /* ------------------------------------------------------------------------ 392 * Debugging & dumpsys 393 */ 394 void listLayersLocked(const Vector<String16>& args, size_t& index, String8& result) const; 395 void dumpStatsLocked(const Vector<String16>& args, size_t& index, String8& result) const; 396 void clearStatsLocked(const Vector<String16>& args, size_t& index, String8& result); 397 void dumpAllLocked(const Vector<String16>& args, size_t& index, String8& result) const; 398 bool startDdmConnection(); 399 static void appendSfConfigString(String8& result); 400 void checkScreenshot(size_t w, size_t s, size_t h, void const* vaddr, 401 const sp<const DisplayDevice>& hw, 402 uint32_t minLayerZ, uint32_t maxLayerZ); 403 404 void logFrameStats(); 405 406 /* ------------------------------------------------------------------------ 407 * Attributes 408 */ 409 410 // access must be protected by mStateLock 411 mutable Mutex mStateLock; 412 State mCurrentState; 413 volatile int32_t mTransactionFlags; 414 Condition mTransactionCV; 415 bool mTransactionPending; 416 bool mAnimTransactionPending; 417 Vector< sp<Layer> > mLayersPendingRemoval; 418 SortedVector< wp<IBinder> > mGraphicBufferProducerList; 419 420 // protected by mStateLock (but we could use another lock) 421 bool mLayersRemoved; 422 423 // access must be protected by mInvalidateLock 424 volatile int32_t mRepaintEverything; 425 426 // constant members (no synchronization needed for access) 427 HWComposer* mHwc; 428 RenderEngine* mRenderEngine; 429 nsecs_t mBootTime; 430 bool mGpuToCpuSupported; 431 sp<EventThread> mEventThread; 432 sp<EventThread> mSFEventThread; 433 sp<EventControlThread> mEventControlThread; 434 EGLContext mEGLContext; 435 EGLDisplay mEGLDisplay; 436 sp<IBinder> mBuiltinDisplays[DisplayDevice::NUM_BUILTIN_DISPLAY_TYPES]; 437 438 // Can only accessed from the main thread, these members 439 // don't need synchronization 440 State mDrawingState; 441 bool mVisibleRegionsDirty; 442 bool mHwWorkListDirty; 443 bool mAnimCompositionPending; 444 445 // this may only be written from the main thread with mStateLock held 446 // it may be read from other threads with mStateLock held 447 DefaultKeyedVector< wp<IBinder>, sp<DisplayDevice> > mDisplays; 448 449 // don't use a lock for these, we don't care 450 int mDebugRegion; 451 int mDebugDDMS; 452 int mDebugDisableHWC; 453 int mDebugDisableTransformHint; 454 volatile nsecs_t mDebugInSwapBuffers; 455 nsecs_t mLastSwapBufferTime; 456 volatile nsecs_t mDebugInTransaction; 457 nsecs_t mLastTransactionTime; 458 bool mBootFinished; 459 460 // these are thread safe 461 mutable MessageQueue mEventQueue; 462 FrameTracker mAnimFrameTracker; 463 DispSync mPrimaryDispSync; 464 465 // protected by mDestroyedLayerLock; 466 mutable Mutex mDestroyedLayerLock; 467 Vector<Layer const *> mDestroyedLayers; 468 469 // protected by mHWVsyncLock 470 Mutex mHWVsyncLock; 471 bool mPrimaryHWVsyncEnabled; 472 bool mHWVsyncAvailable; 473 474 /* ------------------------------------------------------------------------ 475 * Feature prototyping 476 */ 477 478 Daltonizer mDaltonizer; 479 bool mDaltonize; 480 481 mat4 mColorMatrix; 482 bool mHasColorMatrix; 483}; 484 485}; // namespace android 486 487#endif // ANDROID_SURFACE_FLINGER_H 488