SurfaceFlinger.h revision ad456f9878ff7c176499e7b992f9ff1cb3e9cdee
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 <utils/SortedVector.h> 24#include <utils/KeyedVector.h> 25#include <utils/threads.h> 26#include <utils/Atomic.h> 27#include <utils/Errors.h> 28#include <utils/RefBase.h> 29 30#include <binder/IMemory.h> 31#include <binder/Permission.h> 32#include <binder/BinderService.h> 33 34#include <ui/PixelFormat.h> 35#include <surfaceflinger/ISurfaceComposer.h> 36#include <surfaceflinger/ISurfaceComposerClient.h> 37 38#include "Barrier.h" 39#include "Layer.h" 40 41#include "MessageQueue.h" 42 43namespace android { 44 45// --------------------------------------------------------------------------- 46 47class Client; 48class DisplayHardware; 49class FreezeLock; 50class Layer; 51class LayerDim; 52 53#define LIKELY( exp ) (__builtin_expect( (exp) != 0, true )) 54#define UNLIKELY( exp ) (__builtin_expect( (exp) != 0, false )) 55 56// --------------------------------------------------------------------------- 57 58class Client : public BnSurfaceComposerClient 59{ 60public: 61 Client(const sp<SurfaceFlinger>& flinger); 62 ~Client(); 63 64 status_t initCheck() const; 65 66 // protected by SurfaceFlinger::mStateLock 67 ssize_t attachLayer(const sp<LayerBaseClient>& layer); 68 void detachLayer(const LayerBaseClient* layer); 69 sp<LayerBaseClient> getLayerUser(int32_t i) const; 70 71private: 72 73 // ISurfaceComposerClient interface 74 virtual sp<IMemoryHeap> getControlBlock() const; 75 virtual ssize_t getTokenForSurface(const sp<ISurface>& sur) const; 76 virtual sp<ISurface> createSurface( 77 surface_data_t* params, int pid, const String8& name, 78 DisplayID display, uint32_t w, uint32_t h,PixelFormat format, 79 uint32_t flags); 80 virtual status_t destroySurface(SurfaceID surfaceId); 81 virtual status_t setState(int32_t count, const layer_state_t* states); 82 83 DefaultKeyedVector< size_t, wp<LayerBaseClient> > mLayers; 84 sp<SurfaceFlinger> mFlinger; 85 int32_t mNameGenerator; 86}; 87 88class UserClient : public BnSurfaceComposerClient 89{ 90public: 91 // pointer to this client's control block 92 SharedClient* ctrlblk; 93 94public: 95 UserClient(const sp<SurfaceFlinger>& flinger); 96 ~UserClient(); 97 98 status_t initCheck() const; 99 100 // protected by SurfaceFlinger::mStateLock 101 void detachLayer(const Layer* layer); 102 103private: 104 105 // ISurfaceComposerClient interface 106 virtual sp<IMemoryHeap> getControlBlock() const; 107 virtual ssize_t getTokenForSurface(const sp<ISurface>& sur) const; 108 virtual sp<ISurface> createSurface( 109 surface_data_t* params, int pid, const String8& name, 110 DisplayID display, uint32_t w, uint32_t h,PixelFormat format, 111 uint32_t flags); 112 virtual status_t destroySurface(SurfaceID surfaceId); 113 virtual status_t setState(int32_t count, const layer_state_t* states); 114 115 // atomic-ops 116 mutable volatile int32_t mBitmap; 117 118 sp<IMemoryHeap> mCblkHeap; 119 sp<SurfaceFlinger> mFlinger; 120}; 121 122// --------------------------------------------------------------------------- 123 124class GraphicPlane 125{ 126public: 127 static status_t orientationToTransfrom(int orientation, int w, int h, 128 Transform* tr); 129 130 GraphicPlane(); 131 ~GraphicPlane(); 132 133 bool initialized() const; 134 135 void setDisplayHardware(DisplayHardware *); 136 status_t setOrientation(int orientation); 137 int getOrientation() const { return mOrientation; } 138 int getWidth() const; 139 int getHeight() const; 140 141 const DisplayHardware& displayHardware() const; 142 DisplayHardware& editDisplayHardware(); 143 const Transform& transform() const; 144 EGLDisplay getEGLDisplay() const; 145 146private: 147 GraphicPlane(const GraphicPlane&); 148 GraphicPlane operator = (const GraphicPlane&); 149 150 DisplayHardware* mHw; 151 Transform mGlobalTransform; 152 Transform mDisplayTransform; 153 int mOrientation; 154 float mDisplayWidth; 155 float mDisplayHeight; 156 int mWidth; 157 int mHeight; 158}; 159 160// --------------------------------------------------------------------------- 161 162enum { 163 eTransactionNeeded = 0x01, 164 eTraversalNeeded = 0x02 165}; 166 167class SurfaceFlinger : 168 public BinderService<SurfaceFlinger>, 169 public BnSurfaceComposer, 170 protected Thread 171{ 172public: 173 static char const* getServiceName() { return "SurfaceFlinger"; } 174 175 SurfaceFlinger(); 176 virtual ~SurfaceFlinger(); 177 void init(); 178 179 virtual status_t onTransact( 180 uint32_t code, const Parcel& data, Parcel* reply, uint32_t flags); 181 182 virtual status_t dump(int fd, const Vector<String16>& args); 183 184 // ISurfaceComposer interface 185 virtual sp<ISurfaceComposerClient> createConnection(); 186 virtual sp<ISurfaceComposerClient> createClientConnection(); 187 virtual sp<IMemoryHeap> getCblk() const; 188 virtual void bootFinished(); 189 virtual void openGlobalTransaction(); 190 virtual void closeGlobalTransaction(); 191 virtual status_t freezeDisplay(DisplayID dpy, uint32_t flags); 192 virtual status_t unfreezeDisplay(DisplayID dpy, uint32_t flags); 193 virtual int setOrientation(DisplayID dpy, int orientation, uint32_t flags); 194 virtual void signal() const; 195 196 virtual status_t captureScreen(DisplayID dpy, 197 sp<IMemoryHeap>* heap, 198 uint32_t* width, uint32_t* height, 199 PixelFormat* format, uint32_t reqWidth, uint32_t reqHeight, 200 uint32_t minLayerZ, uint32_t maxLayerZ); 201 202 virtual status_t turnElectronBeamOff(int32_t mode); 203 virtual status_t turnElectronBeamOn(int32_t mode); 204 205 void screenReleased(DisplayID dpy); 206 void screenAcquired(DisplayID dpy); 207 208 status_t removeLayer(const sp<LayerBase>& layer); 209 status_t addLayer(const sp<LayerBase>& layer); 210 status_t invalidateLayerVisibility(const sp<LayerBase>& layer); 211 void invalidateHwcGeometry(); 212 213 sp<Layer> getLayer(const sp<ISurface>& sur) const; 214 215private: 216 friend class Client; 217 friend class LayerBase; 218 friend class LayerBaseClient; 219 friend class LayerBaseClient::Surface; 220 friend class Layer; 221 friend class LayerDim; 222 223 sp<ISurface> createSurface(const sp<Client>& client, 224 int pid, const String8& name, 225 ISurfaceComposerClient::surface_data_t* params, 226 DisplayID display, uint32_t w, uint32_t h, PixelFormat format, 227 uint32_t flags); 228 229 sp<Layer> createNormalSurface( 230 const sp<Client>& client, DisplayID display, 231 uint32_t w, uint32_t h, uint32_t flags, 232 PixelFormat& format); 233 234 sp<LayerDim> createDimSurface( 235 const sp<Client>& client, DisplayID display, 236 uint32_t w, uint32_t h, uint32_t flags); 237 238 status_t removeSurface(const sp<Client>& client, SurfaceID sid); 239 status_t destroySurface(const sp<LayerBaseClient>& layer); 240 status_t setClientState(const sp<Client>& client, 241 int32_t count, const layer_state_t* states); 242 243 class LayerVector : public SortedVector< sp<LayerBase> > { 244 public: 245 LayerVector() { } 246 LayerVector(const LayerVector& rhs) : SortedVector< sp<LayerBase> >(rhs) { } 247 virtual int do_compare(const void* lhs, const void* rhs) const { 248 const sp<LayerBase>& l(*reinterpret_cast<const sp<LayerBase>*>(lhs)); 249 const sp<LayerBase>& r(*reinterpret_cast<const sp<LayerBase>*>(rhs)); 250 // sort layers by Z order 251 uint32_t lz = l->currentState().z; 252 uint32_t rz = r->currentState().z; 253 // then by sequence, so we get a stable ordering 254 return (lz != rz) ? (lz - rz) : (l->sequence - r->sequence); 255 } 256 }; 257 258 struct State { 259 State() { 260 orientation = ISurfaceComposer::eOrientationDefault; 261 freezeDisplay = 0; 262 } 263 LayerVector layersSortedByZ; 264 uint8_t orientation; 265 uint8_t orientationType; 266 uint8_t freezeDisplay; 267 }; 268 269 virtual bool threadLoop(); 270 virtual status_t readyToRun(); 271 virtual void onFirstRef(); 272 273public: // hack to work around gcc 4.0.3 bug 274 const GraphicPlane& graphicPlane(int dpy) const; 275 GraphicPlane& graphicPlane(int dpy); 276private: 277 278 void waitForEvent(); 279public: // hack to work around gcc 4.0.3 bug 280 void signalEvent(); 281private: 282 void handleConsoleEvents(); 283 void handleTransaction(uint32_t transactionFlags); 284 void handleTransactionLocked( 285 uint32_t transactionFlags, 286 Vector< sp<LayerBase> >& ditchedLayers); 287 288 void computeVisibleRegions( 289 LayerVector& currentLayers, 290 Region& dirtyRegion, 291 Region& wormholeRegion); 292 293 void handlePageFlip(); 294 bool lockPageFlip(const LayerVector& currentLayers); 295 void unlockPageFlip(const LayerVector& currentLayers); 296 void handleWorkList(); 297 void handleRepaint(); 298 void postFramebuffer(); 299 void composeSurfaces(const Region& dirty); 300 void unlockClients(); 301 302 303 ssize_t addClientLayer(const sp<Client>& client, 304 const sp<LayerBaseClient>& lbc); 305 status_t addLayer_l(const sp<LayerBase>& layer); 306 status_t removeLayer_l(const sp<LayerBase>& layer); 307 status_t purgatorizeLayer_l(const sp<LayerBase>& layer); 308 309 uint32_t getTransactionFlags(uint32_t flags); 310 uint32_t setTransactionFlags(uint32_t flags); 311 void commitTransaction(); 312 313 314 status_t captureScreenImplLocked(DisplayID dpy, 315 sp<IMemoryHeap>* heap, 316 uint32_t* width, uint32_t* height, PixelFormat* format, 317 uint32_t reqWidth, uint32_t reqHeight, 318 uint32_t minLayerZ, uint32_t maxLayerZ); 319 320 status_t turnElectronBeamOffImplLocked(int32_t mode); 321 status_t turnElectronBeamOnImplLocked(int32_t mode); 322 status_t electronBeamOffAnimationImplLocked(); 323 status_t electronBeamOnAnimationImplLocked(); 324 status_t renderScreenToTextureLocked(DisplayID dpy, 325 GLuint* textureName, GLfloat* uOut, GLfloat* vOut); 326 sp<GraphicBuffer> createGraphicBuffer(uint32_t w, uint32_t h, 327 PixelFormat format, uint32_t usage) const; 328 329 friend class FreezeLock; 330 sp<FreezeLock> getFreezeLock() const; 331 inline void incFreezeCount() { 332 if (mFreezeCount == 0) 333 mFreezeDisplayTime = 0; 334 mFreezeCount++; 335 } 336 inline void decFreezeCount() { if (mFreezeCount > 0) mFreezeCount--; } 337 inline bool hasFreezeRequest() const { return mFreezeDisplay; } 338 inline bool isFrozen() const { 339 return (mFreezeDisplay || mFreezeCount>0) && mBootFinished; 340 } 341 342 343 void debugFlashRegions(); 344 void debugShowFPS() const; 345 void drawWormhole() const; 346 347 348 mutable MessageQueue mEventQueue; 349 350 status_t postMessageAsync(const sp<MessageBase>& msg, 351 nsecs_t reltime=0, uint32_t flags = 0); 352 353 status_t postMessageSync(const sp<MessageBase>& msg, 354 nsecs_t reltime=0, uint32_t flags = 0); 355 356 // access must be protected by mStateLock 357 mutable Mutex mStateLock; 358 State mCurrentState; 359 State mDrawingState; 360 volatile int32_t mTransactionFlags; 361 volatile int32_t mTransactionCount; 362 Condition mTransactionCV; 363 bool mResizeTransationPending; 364 365 // protected by mStateLock (but we could use another lock) 366 GraphicPlane mGraphicPlanes[1]; 367 bool mLayersRemoved; 368 DefaultKeyedVector< wp<IBinder>, wp<Layer> > mLayerMap; 369 370 // constant members (no synchronization needed for access) 371 sp<IMemoryHeap> mServerHeap; 372 surface_flinger_cblk_t* mServerCblk; 373 GLuint mWormholeTexName; 374 nsecs_t mBootTime; 375 Permission mHardwareTest; 376 Permission mAccessSurfaceFlinger; 377 Permission mReadFramebuffer; 378 Permission mDump; 379 380 // Can only accessed from the main thread, these members 381 // don't need synchronization 382 Region mDirtyRegion; 383 Region mDirtyRegionRemovedLayer; 384 Region mInvalidRegion; 385 Region mWormholeRegion; 386 bool mVisibleRegionsDirty; 387 bool mHwWorkListDirty; 388 bool mDeferReleaseConsole; 389 bool mFreezeDisplay; 390 int32_t mElectronBeamAnimationMode; 391 int32_t mFreezeCount; 392 nsecs_t mFreezeDisplayTime; 393 Vector< sp<LayerBase> > mVisibleLayersSortedByZ; 394 395 396 // don't use a lock for these, we don't care 397 int mDebugRegion; 398 int mDebugBackground; 399 int mDebugDisableHWC; 400 volatile nsecs_t mDebugInSwapBuffers; 401 nsecs_t mLastSwapBufferTime; 402 volatile nsecs_t mDebugInTransaction; 403 nsecs_t mLastTransactionTime; 404 bool mBootFinished; 405 406 // these are thread safe 407 mutable Barrier mReadyToRunBarrier; 408 409 // atomic variables 410 enum { 411 eConsoleReleased = 1, 412 eConsoleAcquired = 2 413 }; 414 volatile int32_t mConsoleSignals; 415 416 // only written in the main thread, only read in other threads 417 volatile int32_t mSecureFrameBuffer; 418}; 419 420// --------------------------------------------------------------------------- 421 422class FreezeLock : public LightRefBase<FreezeLock> { 423 SurfaceFlinger* mFlinger; 424public: 425 FreezeLock(SurfaceFlinger* flinger) 426 : mFlinger(flinger) { 427 mFlinger->incFreezeCount(); 428 } 429 ~FreezeLock() { 430 mFlinger->decFreezeCount(); 431 } 432}; 433 434// --------------------------------------------------------------------------- 435}; // namespace android 436 437#endif // ANDROID_SURFACE_FLINGER_H 438